Commit 954742e1 authored by Javokhir's avatar Javokhir
Browse files

docs: note that sessionId must be a UUID

Verified against the MyID backend: a non-UUID sessionId is rejected with code
103 before the SDK UI appears.
parent 65bc5a60
......@@ -18,7 +18,8 @@ const result = await start({
| Android | `minSdkVersion` 24+, `compileSdk` 36 |
| iOS | Deployment target 15.1+ (RN 0.86's floor; the MyID SDK itself needs 13.0) |
`sessionId` is issued by **your backend** through the MyID API. This library
`sessionId` is issued by **your backend** through the MyID API and must be a
UUID; the MyID backend rejects any other format with code `103`. This library
never talks to the MyID backend itself — it only launches the SDK.
## Installation
......@@ -99,7 +100,7 @@ own. Options not supported by a platform are ignored there rather than throwing.
| Option | Values | Default | Platform |
|---|---|---|---|
| `sessionId` | string | — | both |
| `sessionId` | string (UUID) | — | both |
| `clientHash` | string | — | both |
| `clientHashId` | string | — | both |
| `minAge` | number | `16` | both |
......
GEM
remote: https://rubygems.org/
specs:
CFPropertyList (3.0.9)
activesupport (7.2.3.2)
base64
benchmark (>= 0.3)
bigdecimal
concurrent-ruby (~> 1.0, >= 1.3.1)
connection_pool (>= 2.2.5)
drb
i18n (>= 1.6, < 2)
logger (>= 1.4.2)
minitest (>= 5.1, < 6)
securerandom (>= 0.3)
tzinfo (~> 2.0, >= 2.0.5)
addressable (2.9.0)
public_suffix (>= 2.0.2, < 8.0)
algoliasearch (1.27.5)
httpclient (~> 2.8, >= 2.8.3)
json (>= 1.5.1)
atomos (0.1.3)
base64 (0.3.0)
benchmark (0.5.0)
bigdecimal (4.1.3)
claide (1.1.0)
cocoapods (1.15.2)
addressable (~> 2.8)
claide (>= 1.0.2, < 2.0)
cocoapods-core (= 1.15.2)
cocoapods-deintegrate (>= 1.0.3, < 2.0)
cocoapods-downloader (>= 2.1, < 3.0)
cocoapods-plugins (>= 1.0.0, < 2.0)
cocoapods-search (>= 1.0.0, < 2.0)
cocoapods-trunk (>= 1.6.0, < 2.0)
cocoapods-try (>= 1.1.0, < 2.0)
colored2 (~> 3.1)
escape (~> 0.0.4)
fourflusher (>= 2.3.0, < 3.0)
gh_inspector (~> 1.0)
molinillo (~> 0.8.0)
nap (~> 1.0)
ruby-macho (>= 2.3.0, < 3.0)
xcodeproj (>= 1.23.0, < 2.0)
cocoapods-core (1.15.2)
activesupport (>= 5.0, < 8)
addressable (~> 2.8)
algoliasearch (~> 1.0)
concurrent-ruby (~> 1.1)
fuzzy_match (~> 2.0.4)
nap (~> 1.0)
netrc (~> 0.11)
public_suffix (~> 4.0)
typhoeus (~> 1.0)
cocoapods-deintegrate (1.0.5)
cocoapods-downloader (2.1)
cocoapods-plugins (1.0.0)
nap
cocoapods-search (1.0.1)
cocoapods-trunk (1.6.0)
nap (>= 0.8, < 2.0)
netrc (~> 0.11)
cocoapods-try (1.2.0)
colored2 (3.1.2)
concurrent-ruby (1.3.3)
connection_pool (2.5.5)
drb (2.2.3)
escape (0.0.4)
ethon (0.18.0)
ffi (>= 1.15.0)
logger
ffi (1.17.4)
fourflusher (2.3.1)
fuzzy_match (2.0.4)
gh_inspector (1.1.3)
httpclient (2.9.0)
mutex_m
i18n (1.15.2)
concurrent-ruby (~> 1.0)
json (3.0.2)
logger (1.7.0)
minitest (5.27.0)
molinillo (0.8.0)
mutex_m (0.3.0)
nanaimo (0.3.0)
nap (1.1.0)
netrc (0.11.0)
nkf (0.3.0)
public_suffix (4.0.7)
rexml (3.4.4)
ruby-macho (2.5.1)
securerandom (0.4.1)
typhoeus (1.6.0)
ethon (>= 0.18.0)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
xcodeproj (1.25.1)
CFPropertyList (>= 2.3.3, < 4.0)
atomos (~> 0.1.3)
claide (>= 1.0.2, < 2.0)
colored2 (~> 3.1)
nanaimo (~> 0.3.0)
rexml (>= 3.3.6, < 4.0)
PLATFORMS
ruby
DEPENDENCIES
activesupport (>= 6.1.7.5, != 7.1.0)
benchmark
bigdecimal
cocoapods (>= 1.13, != 1.15.1, != 1.15.0)
concurrent-ruby (< 1.3.4)
logger
mutex_m
nkf
xcodeproj (< 1.26.0)
RUBY VERSION
ruby 3.1.3p185
BUNDLED WITH
2.3.26
......@@ -2094,78 +2094,78 @@ SPEC CHECKSUMS:
RCTDeprecation: bccb6545c26db881ecddfd83a3f9ea82aba1605f
RCTRequired: b2f74764d596fc0051f00fee94b49bf41a6f7f5a
RCTSwiftUI: c6d6a31b849b9dfa64c33b55dc91ac15dd55774c
RCTSwiftUIWrapper: 0106c38ccc929e3b2f8815c50ab873e345ab2777
RCTSwiftUIWrapper: bdff268d65d662a79b1e571e841e1512275f9319
RCTTypeSafety: 159e394bdab42023fbdd8fa022dfdc5577a8b9ad
React: 4b2532a459d15e1adf6c22d3e399e5c85a94220f
React-callinvoker: 0b8ce4057e02a0bd15cf0532596e8eb8c0392e92
React-Core: 52b990bb36640833e636d5efc817ad4700dd7f93
React-Core: 5af045531a540ba3f65f07de1e3f585ddfb27948
React-Core-prebuilt: 39eb00d8ba4922167a3a70e2039b102fe42b6fe1
React-CoreModules: 43516d84b3851a850a835d32ec740db319e7bf9e
React-cxxreact: 9254233b543b9f49bdbcad329603e70be5582a0e
React-CoreModules: 99b194a721de84ccfc1be149a0de52647dc38c0e
React-cxxreact: b7e8e254074fd8111d147202b391ccf7816946a6
React-debug: 6bc17013f4dc724c23c91e1c83220251d1eacee6
React-defaultsnativemodule: deed608618274d6b9e395d0bb91925ec1384c827
React-domnativemodule: 8a7604a27a33d0b7ea3acd6ef5e556935af506a2
React-Fabric: e4f68a49e82aeb25e1f144d50ffa32dfb629cf16
React-FabricComponents: 7326b9ae2c2162033ba1d10713a2a6b0e762a990
React-FabricImage: e84692d44ac1a1c1560e86fad772449a033ef327
React-featureflags: 78f3d05ae8cbcfc3e26524954516fd1f8307d0ab
React-featureflagsnativemodule: c4f65ff56d5435db590214243e47cfdfdb7cf828
React-graphics: 394bd9e1311370733f770af9ba389e07e069a5d0
React-hermes: 9f44a83eca48842bd3f60fdc16bdb4fa29105eae
React-idlecallbacksnativemodule: 0ea88c4d02c347b18d8767bc85bda53e4d4821e8
React-ImageManager: 511d829cde144ba19a9b81007d1c44857d35c23e
React-intersectionobservernativemodule: 6fbd27810c75eac0beb09ea6b4d6fa8affd3c2d8
React-jserrorhandler: 695c432fcac6469bdfc28448a6315f84b58b18ec
React-jsi: 40bd06de577b224175f2ce5b4eb2cffa449c86df
React-jsiexecutor: 0c6068034234dd6910fa6d82f378f75bcc02a8b7
React-jsinspector: f1d093a0bc5cceb0c2d70a795208faf78135b4f9
React-jsinspectorcdp: 715b446a0e94cff9b3ee39131b39a58d707e96c5
React-jsinspectornetwork: 9c7351b59a5c05d095d797de8c5ad02f2e6e454c
React-jsinspectortracing: 464f0c731f7e9bb315073a1c3ea580feec29a07f
React-jsitooling: 08d95836603e386299044c72ce55a9e5ccd33be3
React-jsitracing: 3be389b754562dac073e4c167a010b9a91955417
React-logger: de0bd725e905e9be3ab919a4206666eec7c3e248
React-Mapbuffer: bfc59384f088a74c1cbe31902b5ba3d89c5947ce
React-microtasksnativemodule: 4e4a0a4e42861c767989099d02cd871dbe11736f
React-mutationobservernativemodule: 6aaa67618b68a616b1293967c20a1dfcc26632a5
React-NativeModulesApple: f313ed47b56405d621e12ecda106a72020959ff3
React-networking: a0686d5a80eddbcd7bb702421fca503a76aacb1a
React-defaultsnativemodule: aec0c526e254a5ce43c79fecb83123f4aecd4199
React-domnativemodule: edd8f47d850a7d3fae0626b624a669e8a9e40f21
React-Fabric: a3b0ce70506ac2e737b9cd6667877382f2ee2f29
React-FabricComponents: 18bf172f8dc2308cb93c539713a3ac778192e225
React-FabricImage: 260ea6794cb5d08aacc0f591110bbf66dfc3ed80
React-featureflags: 828f711206ab1a3aa0ec40f39d9f7f793352489d
React-featureflagsnativemodule: cc62b7be20aa1e76efde77550dbc34db8556d604
React-graphics: 9a9fa8dd605d210a43d88e7d4c78bfff544b09ad
React-hermes: 6fd579ceeb680830fc508697acdd5e8cd8dbf29f
React-idlecallbacksnativemodule: af59e31212470464d6e6fda0f6cc7e5c413b5d29
React-ImageManager: 5c97e7ce5c37335c0392f629daba4c2143f0be2f
React-intersectionobservernativemodule: ea5682b04b6cff32fe57d5f0f530f07c33a55b34
React-jserrorhandler: baa4284f642fd0cbcf7664860abe7e18e54d05de
React-jsi: 7b14065a285f91b3dbe5448371ff575bbb523d59
React-jsiexecutor: 10b4ba40ec9fd571370dfee20251201f57712e79
React-jsinspector: ec4602cc56d9ec4c7789017a51a639052d4642e0
React-jsinspectorcdp: 46a17a5e80e4c84e734ba9cbc8fe4efaa496722a
React-jsinspectornetwork: a6743d072cb0e383de2b9bc7ddc4c824e617c681
React-jsinspectortracing: 24b2dd80722ef691af02d4aa6a1e32e1f61d9bfb
React-jsitooling: e483e01f15f2b11d8f5317372de762deaff4dcd9
React-jsitracing: db1285e61be69980443ca27e4f8dea36f8a3b906
React-logger: 35ab012027cc552057f7ca5d031c6721f896e6bc
React-Mapbuffer: 44dd007f917e2396afa0e70bbd70273237d93fde
React-microtasksnativemodule: f413ee411341fb3c34d20e85e9f6f524921fab15
React-mutationobservernativemodule: 58f6d2adf7d98e72b241608dfa2ddce414d2a4e7
React-NativeModulesApple: 167e532fb9bae30f3c66636b8ee0092bab263667
React-networking: 89f6b69755a3176f30e56ba1ba8e214b1518ecfb
React-oscompat: db6675ddaef3bddd1b41533627f3d26ec710c05f
React-perflogger: 21ca12b8deb8411c6fa4a564e6e4e0800390b556
React-performancecdpmetrics: 8497263114d72822f737e0b78aad26c85b2099bf
React-performancetimeline: bb4ca5f73f04b1074d2fe35dd574f30e58fbd733
React-perflogger: c34660c72849d23319f5e544c97e6c6ed687b186
React-performancecdpmetrics: 13ce0ca13d32007b7369f295c81bfad6316514bc
React-performancetimeline: b68271d5199dc356a80b661bb05622f5ed6777fb
React-RCTActionSheet: 7d18777c531c516ab9f86342583057b15fb7fd7d
React-RCTAnimation: 14a2fdc1165d73dc96abd0935e89c2127a119fbd
React-RCTAppDelegate: 0b5a06df526fe79b2a5cbe90b889e28867e14574
React-RCTBlob: f2ebb238c43a631f541377ec18ed60bb70665363
React-RCTFabric: 231d533ee1d4eb9db9f876ad8c25878794b53724
React-RCTFBReactNativeSpec: 679afd98830c2cb6cb7a0c31763012cbc74fa486
React-RCTImage: 1d8c5b8786a0f52d0d2613b8ba58c02c1da67c1e
React-RCTLinking: 2560d59e85c82f260bff81fffc4ea30bc66a500b
React-RCTNetwork: d331a823911e70fd1de7eeddaa739f4c54dcacc4
React-RCTRuntime: b1cc28447a887ac6f1b1d383d93d1f9360b1b6e8
React-RCTSettings: b7896598aa87af4b907628164240e87457e6f830
React-RCTText: 1eb82d0798487adcf394a12d8fad825722d1a376
React-RCTVibration: 0c76a15901bb1c8d47a8a02dc16f95f39ed3ffb5
React-RCTAnimation: f2505067d2d83268f5619192f8f5ff14b2606c7f
React-RCTAppDelegate: 7bfa4d752f45a0b9195b8da0f188f8904806a86f
React-RCTBlob: 7b4d25eca2a6ecd83766d76790879774b73b4cd5
React-RCTFabric: a225895f3fd2b11f2c44b13229f2d99065eedda1
React-RCTFBReactNativeSpec: cb15356d207d325e689eca0c7b15d737aac8c6dc
React-RCTImage: 9123b010921479b5bcd3771a4a4d4e788227a427
React-RCTLinking: 358d42629d7012c5d75060fd3e25023b72ebae31
React-RCTNetwork: 32f5274abd61e937bdcbfd85810ae784d3f0e38a
React-RCTRuntime: b11ef93babc2be36f5e10835d246e0e623f6570b
React-RCTSettings: 86aa6e6a3a335d989e3fcd1bd98b9ea6331adfa9
React-RCTText: 59376611225f3c6fdc75d57571d7c345bdd0be1e
React-RCTVibration: 3c7d17d3373c114220be9ac3b99df1646009b8fe
React-rendererconsistency: c9a2d2351407696ccbefdeb53b4aee109c4cb008
React-renderercss: f47a328de59fa4f6a86900e9c57533aae3a9c02f
React-rendererdebug: d160cfa801014fb69206f0b4cde4c1e78805b766
React-RuntimeApple: bdfe33451e5ad94bb6cda9f259da6682f0da2e83
React-RuntimeCore: 5924b98279f2729b50b34a59f379d8bdd66425e6
React-runtimeexecutor: 1d8152478961e2eba5137d6cfeaf44037e84974d
React-RuntimeHermes: 93211f1da41bee7a5a5b4095b47504beffae98de
React-runtimescheduler: 4cd060f43d1bfb03b30ad876925e018ca0f89f0e
React-timing: 3e175c2d74410262027458380950122a18b1edf0
React-utils: 9e3bc5d5f28e4333605df0d6cd5873ea29936715
React-viewtransitionnativemodule: 6958f31ac3ed27ccb4da3446d4041da111b63949
React-webperformancenativemodule: a52e599962a9be3c06ed00470e71e3c3d94f942f
ReactAppDependencyProvider: 082ef199e27011a4314f499b6b2e2ac29e141267
ReactCodegen: bb259ec28a456704be0a3485e93096a497a29917
ReactCommon: 00d8d68c7aa036745334d3a3844102ecd9bf099d
React-renderercss: 883aebdf574736450571800eeb3edbc804385c76
React-rendererdebug: fc1e330efedfd4dfe4fd7d75736f9a219dae196f
React-RuntimeApple: f099a47224222ddfc7ddaffdd9aa2ac47a216ee0
React-RuntimeCore: e91b17661cc543f4a241e69b3f038182d7db8fd6
React-runtimeexecutor: d27e321bd8e04d4737bc8924473a25defb33a031
React-RuntimeHermes: 760a0793748cb12b4dd11f323bd516668b7e3b99
React-runtimescheduler: df1c84ed1a5b78a1a7953d3e86db6163c4542906
React-timing: 791690a2daa7b13554060f6836c260c8bc311a98
React-utils: 13f4f227561d2660201dee5cbea253c07d8b5d3a
React-viewtransitionnativemodule: 93335dacae2dd7db207320f384111c2b4c58fca8
React-webperformancenativemodule: 0bed183d6447493571431c031ad2401c027b5866
ReactAppDependencyProvider: 0e13d430eadac8a2ef18515a860d5c59df05b475
ReactCodegen: 3bbb7de19774794a7428ef623a7b777106cf3737
ReactCommon: 9002f006f571256348994183f7d4387aa7cf84e8
ReactNativeDependencies: 2bd6854ade79bf1b60586d1ab7813a389df1b6bf
RNMyidSdk: 61b5d9f0f160f2e2bb31fb7141ae11efa8d0048b
RNMyidSdk: 7a408048db0f274bef2ea2d87281ed28e49dd83a
Yoga: 9891cfb1c680f64de9c41b09e7453dea33454d2b
PODFILE CHECKSUM: 0bcd69ab07f3ea65c598968373d4e24c9806835d
COCOAPODS: 1.16.2
COCOAPODS: 1.15.2
......@@ -42,7 +42,10 @@ export type MyIdOrganizationDetails = {
* platform.
*/
export type MyIdConfig = {
/** Issued by your backend via the MyID API. Not a client-side value. */
/**
* Issued by your backend via the MyID API. Not a client-side value.
* Must be a UUID — the backend rejects anything else with code `103`.
*/
sessionId: string;
/** Provided by the MyID sales team. Treat as a secret. */
clientHash: string;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment