stytch 10.26.0 → 10.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/stytch/b2b_discovery.rb +1 -1
- data/lib/stytch/b2b_magic_links.rb +3 -3
- data/lib/stytch/b2b_oauth.rb +1 -1
- data/lib/stytch/b2b_organizations.rb +33 -23
- data/lib/stytch/b2b_otp.rb +5 -5
- data/lib/stytch/b2b_passwords.rb +7 -7
- data/lib/stytch/b2b_recovery_codes.rb +3 -3
- data/lib/stytch/b2b_scim.rb +8 -8
- data/lib/stytch/b2b_sessions.rb +3 -3
- data/lib/stytch/b2b_sso.rb +10 -10
- data/lib/stytch/b2b_totps.rb +3 -3
- data/lib/stytch/passwords.rb +3 -3
- data/lib/stytch/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 49aa54d3b047309a521fa267920e138f8eb27e8c299f5228c4c8bc565f821ce6
|
4
|
+
data.tar.gz: 716a18a6bcdc9ce4288287678e204d47ae90a89a7f432e43234afa2744419e04
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 07cfbe4bbf895019aefd6be0d2fef3376caa5cb84fadd5c1af9c26d7d2e2ffd5399e5d9d3e2704cce5af85dc3eff494ad2ff648b1783434c933223c9408eafff
|
7
|
+
data.tar.gz: 55b223a9d0deabcc07810029395f1bd117c7df2b55db9b3e814e0dc8ce68e48737b2855b65888bb0f4039b14b90849acba473f3ab3961da61272e85198542c74
|
data/lib/stytch/b2b_discovery.rb
CHANGED
@@ -48,7 +48,7 @@ module StytchB2B
|
|
48
48
|
# The Intermediate Session Token. This token does not necessarily belong to a specific instance of a Member, but represents a bag of factors that may be converted to a member session. The token can be used with the [OTP SMS Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](https://stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. The token has a default expiry of 10 minutes. It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a specific Organization that allows the factors represented by the intermediate session token; or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member. Intermediate Session Tokens have a default expiry of 10 minutes.
|
49
49
|
# The type of this field is +String+.
|
50
50
|
# organization_id::
|
51
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
51
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
52
52
|
# The type of this field is +String+.
|
53
53
|
# session_duration_minutes::
|
54
54
|
# Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,
|
@@ -20,7 +20,7 @@ module StytchB2B
|
|
20
20
|
@discovery = StytchB2B::MagicLinks::Discovery.new(@connection)
|
21
21
|
end
|
22
22
|
|
23
|
-
# Authenticate a Member with a Magic Link. This endpoint requires a Magic Link token that is not expired or previously used. If the Member
|
23
|
+
# Authenticate a Member with a Magic Link. This endpoint requires a Magic Link token that is not expired or previously used. If the Member's status is `pending` or `invited`, they will be updated to `active`.
|
24
24
|
# Provide the `session_duration_minutes` parameter to set the lifetime of the session. If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration.
|
25
25
|
#
|
26
26
|
# If the Member is required to complete MFA to log in to the Organization, the returned value of `member_authenticated` will be `false`, and an `intermediate_session_token` will be returned.
|
@@ -187,7 +187,7 @@ module StytchB2B
|
|
187
187
|
#
|
188
188
|
# == Parameters:
|
189
189
|
# organization_id::
|
190
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
190
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
191
191
|
# The type of this field is +String+.
|
192
192
|
# email_address::
|
193
193
|
# The email address of the Member.
|
@@ -287,7 +287,7 @@ module StytchB2B
|
|
287
287
|
#
|
288
288
|
# == Parameters:
|
289
289
|
# organization_id::
|
290
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
290
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
291
291
|
# The type of this field is +String+.
|
292
292
|
# email_address::
|
293
293
|
# The email address of the Member.
|
data/lib/stytch/b2b_oauth.rb
CHANGED
@@ -31,7 +31,7 @@ module StytchB2B
|
|
31
31
|
# If the Member is logging in via an OAuth provider that does not fully verify the email, the returned value of `member_authenticated` will be `false`, and an `intermediate_session_token` will be returned.
|
32
32
|
# The `primary_required` field details the authentication flow the Member must perform in order to [complete a step-up authentication](https://stytch.com/docs/b2b/guides/oauth/auth-flows) into the organization. The `intermediate_session_token` must be passed into that authentication flow.
|
33
33
|
#
|
34
|
-
# We
|
34
|
+
# We're actively accepting requests for new OAuth providers! Please [email us](mailto:support@stytch.com) or [post in our community](https://stytch.com/docs/b2b/resources) if you are looking for an OAuth provider that is not currently supported.
|
35
35
|
#
|
36
36
|
# == Parameters:
|
37
37
|
# oauth_token::
|
@@ -114,6 +114,9 @@ module StytchB2B
|
|
114
114
|
# trusted_metadata::
|
115
115
|
# An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
|
116
116
|
# The type of this field is nilable +object+.
|
117
|
+
# organization_external_id::
|
118
|
+
# An identifier that can be used in API calls wherever a organization_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within a project, but may be reused across different projects in the same workspace.
|
119
|
+
# The type of this field is nilable +String+.
|
117
120
|
# sso_jit_provisioning::
|
118
121
|
# The authentication setting that controls the JIT provisioning of Members when authenticating via SSO. The accepted values are:
|
119
122
|
#
|
@@ -245,6 +248,7 @@ module StytchB2B
|
|
245
248
|
organization_slug: nil,
|
246
249
|
organization_logo_url: nil,
|
247
250
|
trusted_metadata: nil,
|
251
|
+
organization_external_id: nil,
|
248
252
|
sso_jit_provisioning: nil,
|
249
253
|
email_allowed_domains: nil,
|
250
254
|
email_jit_provisioning: nil,
|
@@ -270,6 +274,7 @@ module StytchB2B
|
|
270
274
|
request[:organization_slug] = organization_slug unless organization_slug.nil?
|
271
275
|
request[:organization_logo_url] = organization_logo_url unless organization_logo_url.nil?
|
272
276
|
request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
|
277
|
+
request[:organization_external_id] = organization_external_id unless organization_external_id.nil?
|
273
278
|
request[:sso_jit_provisioning] = sso_jit_provisioning unless sso_jit_provisioning.nil?
|
274
279
|
request[:email_allowed_domains] = email_allowed_domains unless email_allowed_domains.nil?
|
275
280
|
request[:email_jit_provisioning] = email_jit_provisioning unless email_jit_provisioning.nil?
|
@@ -295,7 +300,7 @@ module StytchB2B
|
|
295
300
|
#
|
296
301
|
# == Parameters:
|
297
302
|
# organization_id::
|
298
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
303
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
299
304
|
# The type of this field is +String+.
|
300
305
|
#
|
301
306
|
# == Returns:
|
@@ -324,7 +329,7 @@ module StytchB2B
|
|
324
329
|
#
|
325
330
|
# == Parameters:
|
326
331
|
# organization_id::
|
327
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
332
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
328
333
|
# The type of this field is +String+.
|
329
334
|
# organization_name::
|
330
335
|
# The name of the Organization. Must be between 1 and 128 characters in length.
|
@@ -346,6 +351,9 @@ module StytchB2B
|
|
346
351
|
# If a session header is passed into the request, this field may **not** be passed into the request. You cannot
|
347
352
|
# update trusted metadata when acting as a Member.
|
348
353
|
# The type of this field is nilable +object+.
|
354
|
+
# organization_external_id::
|
355
|
+
# An identifier that can be used in API calls wherever a organization_id is expected. This is a string consisting of alphanumeric, `.`, `_`, `-`, or `|` characters with a maximum length of 128 characters. External IDs must be unique within a project, but may be reused across different projects in the same workspace.
|
356
|
+
# The type of this field is nilable +String+.
|
349
357
|
# sso_default_connection_id::
|
350
358
|
# The default connection used for SSO when there are multiple active connections.
|
351
359
|
#
|
@@ -516,6 +524,7 @@ module StytchB2B
|
|
516
524
|
organization_slug: nil,
|
517
525
|
organization_logo_url: nil,
|
518
526
|
trusted_metadata: nil,
|
527
|
+
organization_external_id: nil,
|
519
528
|
sso_default_connection_id: nil,
|
520
529
|
sso_jit_provisioning: nil,
|
521
530
|
sso_jit_provisioning_allowed_connections: nil,
|
@@ -544,6 +553,7 @@ module StytchB2B
|
|
544
553
|
request[:organization_slug] = organization_slug unless organization_slug.nil?
|
545
554
|
request[:organization_logo_url] = organization_logo_url unless organization_logo_url.nil?
|
546
555
|
request[:trusted_metadata] = trusted_metadata unless trusted_metadata.nil?
|
556
|
+
request[:organization_external_id] = organization_external_id unless organization_external_id.nil?
|
547
557
|
request[:sso_default_connection_id] = sso_default_connection_id unless sso_default_connection_id.nil?
|
548
558
|
request[:sso_jit_provisioning] = sso_jit_provisioning unless sso_jit_provisioning.nil?
|
549
559
|
request[:sso_jit_provisioning_allowed_connections] = sso_jit_provisioning_allowed_connections unless sso_jit_provisioning_allowed_connections.nil?
|
@@ -571,7 +581,7 @@ module StytchB2B
|
|
571
581
|
#
|
572
582
|
# == Parameters:
|
573
583
|
# organization_id::
|
574
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
584
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
575
585
|
# The type of this field is +String+.
|
576
586
|
#
|
577
587
|
# == Returns:
|
@@ -655,7 +665,7 @@ module StytchB2B
|
|
655
665
|
#
|
656
666
|
# == Parameters:
|
657
667
|
# organization_id::
|
658
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
668
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
659
669
|
# The type of this field is +String+.
|
660
670
|
#
|
661
671
|
# == Returns:
|
@@ -689,7 +699,7 @@ module StytchB2B
|
|
689
699
|
#
|
690
700
|
# == Parameters:
|
691
701
|
# organization_id::
|
692
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
702
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
693
703
|
# The type of this field is +String+.
|
694
704
|
# connected_app_id::
|
695
705
|
# The ID of the Connected App.
|
@@ -957,7 +967,7 @@ module StytchB2B
|
|
957
967
|
#
|
958
968
|
# == Parameters:
|
959
969
|
# organization_id::
|
960
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
970
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
961
971
|
# The type of this field is +String+.
|
962
972
|
# member_id::
|
963
973
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1090,7 +1100,7 @@ module StytchB2B
|
|
1090
1100
|
#
|
1091
1101
|
# == Parameters:
|
1092
1102
|
# organization_id::
|
1093
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1103
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1094
1104
|
# The type of this field is +String+.
|
1095
1105
|
# member_id::
|
1096
1106
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1124,7 +1134,7 @@ module StytchB2B
|
|
1124
1134
|
#
|
1125
1135
|
# == Parameters:
|
1126
1136
|
# organization_id::
|
1127
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1137
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1128
1138
|
# The type of this field is +String+.
|
1129
1139
|
# member_id::
|
1130
1140
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1172,7 +1182,7 @@ module StytchB2B
|
|
1172
1182
|
#
|
1173
1183
|
# == Parameters:
|
1174
1184
|
# organization_id::
|
1175
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1185
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1176
1186
|
# The type of this field is +String+.
|
1177
1187
|
# member_id::
|
1178
1188
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1216,7 +1226,7 @@ module StytchB2B
|
|
1216
1226
|
#
|
1217
1227
|
# == Parameters:
|
1218
1228
|
# organization_id::
|
1219
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1229
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1220
1230
|
# The type of this field is +String+.
|
1221
1231
|
# member_id::
|
1222
1232
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1315,7 +1325,7 @@ module StytchB2B
|
|
1315
1325
|
#
|
1316
1326
|
# == Parameters:
|
1317
1327
|
# organization_id::
|
1318
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1328
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1319
1329
|
# The type of this field is +String+.
|
1320
1330
|
# member_password_id::
|
1321
1331
|
# Globally unique UUID that identifies a Member's password.
|
@@ -1396,7 +1406,7 @@ module StytchB2B
|
|
1396
1406
|
#
|
1397
1407
|
# == Parameters:
|
1398
1408
|
# organization_id::
|
1399
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1409
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1400
1410
|
# The type of this field is +String+.
|
1401
1411
|
# member_id::
|
1402
1412
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1445,7 +1455,7 @@ module StytchB2B
|
|
1445
1455
|
#
|
1446
1456
|
# == Parameters:
|
1447
1457
|
# organization_id::
|
1448
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1458
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1449
1459
|
# The type of this field is +String+.
|
1450
1460
|
# member_id::
|
1451
1461
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1511,7 +1521,7 @@ module StytchB2B
|
|
1511
1521
|
#
|
1512
1522
|
# == Parameters:
|
1513
1523
|
# organization_id::
|
1514
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1524
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1515
1525
|
# The type of this field is +String+.
|
1516
1526
|
# member_id::
|
1517
1527
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1586,7 +1596,7 @@ module StytchB2B
|
|
1586
1596
|
#
|
1587
1597
|
# == Parameters:
|
1588
1598
|
# organization_id::
|
1589
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1599
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1590
1600
|
# The type of this field is +String+.
|
1591
1601
|
# member_id::
|
1592
1602
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1622,7 +1632,7 @@ module StytchB2B
|
|
1622
1632
|
#
|
1623
1633
|
# == Parameters:
|
1624
1634
|
# organization_id::
|
1625
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1635
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1626
1636
|
# The type of this field is +String+.
|
1627
1637
|
# email_address::
|
1628
1638
|
# The email address of the Member.
|
@@ -1714,7 +1724,7 @@ module StytchB2B
|
|
1714
1724
|
#
|
1715
1725
|
# == Parameters:
|
1716
1726
|
# organization_id::
|
1717
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1727
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1718
1728
|
# The type of this field is +String+.
|
1719
1729
|
# member_id::
|
1720
1730
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1773,7 +1783,7 @@ module StytchB2B
|
|
1773
1783
|
#
|
1774
1784
|
# == Parameters:
|
1775
1785
|
# organization_id::
|
1776
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1786
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1777
1787
|
# The type of this field is +String+.
|
1778
1788
|
# member_id::
|
1779
1789
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1830,7 +1840,7 @@ module StytchB2B
|
|
1830
1840
|
#
|
1831
1841
|
# == Parameters:
|
1832
1842
|
# organization_id::
|
1833
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1843
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1834
1844
|
# The type of this field is +String+.
|
1835
1845
|
# member_id::
|
1836
1846
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1886,7 +1896,7 @@ module StytchB2B
|
|
1886
1896
|
#
|
1887
1897
|
# == Parameters:
|
1888
1898
|
# organization_id::
|
1889
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1899
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1890
1900
|
# The type of this field is +String+.
|
1891
1901
|
# member_id::
|
1892
1902
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1922,7 +1932,7 @@ module StytchB2B
|
|
1922
1932
|
#
|
1923
1933
|
# == Parameters:
|
1924
1934
|
# organization_id::
|
1925
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1935
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1926
1936
|
# The type of this field is +String+.
|
1927
1937
|
# member_id::
|
1928
1938
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -1964,7 +1974,7 @@ module StytchB2B
|
|
1964
1974
|
#
|
1965
1975
|
# == Parameters:
|
1966
1976
|
# organization_id::
|
1967
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
1977
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
1968
1978
|
# The type of this field is +String+.
|
1969
1979
|
# member_id::
|
1970
1980
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -2033,7 +2043,7 @@ module StytchB2B
|
|
2033
2043
|
#
|
2034
2044
|
# == Parameters:
|
2035
2045
|
# organization_id::
|
2036
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
2046
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
2037
2047
|
# The type of this field is +String+.
|
2038
2048
|
# member_id::
|
2039
2049
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
data/lib/stytch/b2b_otp.rb
CHANGED
@@ -51,7 +51,7 @@ module StytchB2B
|
|
51
51
|
#
|
52
52
|
# == Parameters:
|
53
53
|
# organization_id::
|
54
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
54
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
55
55
|
# The type of this field is +String+.
|
56
56
|
# member_id::
|
57
57
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -138,7 +138,7 @@ module StytchB2B
|
|
138
138
|
#
|
139
139
|
# == Parameters:
|
140
140
|
# organization_id::
|
141
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
141
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
142
142
|
# The type of this field is +String+.
|
143
143
|
# member_id::
|
144
144
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -257,7 +257,7 @@ module StytchB2B
|
|
257
257
|
#
|
258
258
|
# == Parameters:
|
259
259
|
# organization_id::
|
260
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
260
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
261
261
|
# The type of this field is +String+.
|
262
262
|
# email_address::
|
263
263
|
# The email address of the Member.
|
@@ -327,7 +327,7 @@ module StytchB2B
|
|
327
327
|
end
|
328
328
|
|
329
329
|
# Authenticate a Member with a one-time passcode (OTP). This endpoint requires an OTP that is not expired or previously used.
|
330
|
-
# OTPs have a default expiry of 10 minutes. If the Member
|
330
|
+
# OTPs have a default expiry of 10 minutes. If the Member's status is `pending` or `invited`, they will be updated to `active`.
|
331
331
|
# Provide the `session_duration_minutes` parameter to set the lifetime of the session. If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration.
|
332
332
|
#
|
333
333
|
# If the Member is required to complete MFA to log in to the Organization, the returned value of `member_authenticated` will be `false`, and an `intermediate_session_token` will be returned.
|
@@ -340,7 +340,7 @@ module StytchB2B
|
|
340
340
|
#
|
341
341
|
# == Parameters:
|
342
342
|
# organization_id::
|
343
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
343
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
344
344
|
# The type of this field is +String+.
|
345
345
|
# email_address::
|
346
346
|
# The email address of the Member.
|
data/lib/stytch/b2b_passwords.rb
CHANGED
@@ -110,7 +110,7 @@ module StytchB2B
|
|
110
110
|
# The password hash used. Currently `bcrypt`, `scrypt`, `argon_2i`, `argon_2id`, `md_5`, `sha_1`, and `pbkdf_2` are supported.
|
111
111
|
# The type of this field is +MigrateRequestHashType+ (string enum).
|
112
112
|
# organization_id::
|
113
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
113
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
114
114
|
# The type of this field is +String+.
|
115
115
|
# md_5_config::
|
116
116
|
# Optional parameters for MD-5 hash types.
|
@@ -239,7 +239,7 @@ module StytchB2B
|
|
239
239
|
#
|
240
240
|
# == Parameters:
|
241
241
|
# organization_id::
|
242
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
242
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
243
243
|
# The type of this field is +String+.
|
244
244
|
# email_address::
|
245
245
|
# The email address of the Member.
|
@@ -389,7 +389,7 @@ module StytchB2B
|
|
389
389
|
#
|
390
390
|
# == Parameters:
|
391
391
|
# organization_id::
|
392
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
392
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
393
393
|
# The type of this field is +String+.
|
394
394
|
# email_address::
|
395
395
|
# The email address of the Member to start the email reset process for.
|
@@ -615,7 +615,7 @@ module StytchB2B
|
|
615
615
|
# The email address of the Member to start the email reset process for.
|
616
616
|
# The type of this field is +String+.
|
617
617
|
# organization_id::
|
618
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
618
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
619
619
|
# The type of this field is nilable +String+.
|
620
620
|
# member_id::
|
621
621
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -672,7 +672,7 @@ module StytchB2B
|
|
672
672
|
#
|
673
673
|
# == Parameters:
|
674
674
|
# organization_id::
|
675
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
675
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
676
676
|
# The type of this field is +String+.
|
677
677
|
# password::
|
678
678
|
# The password to authenticate, reset, or set for the first time. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characters, etc.
|
@@ -776,7 +776,7 @@ module StytchB2B
|
|
776
776
|
@connection = connection
|
777
777
|
end
|
778
778
|
|
779
|
-
# Reset the member
|
779
|
+
# Reset the member's password using their existing password.
|
780
780
|
#
|
781
781
|
# This endpoint adapts to your Project's password strength configuration.
|
782
782
|
# If you're using [zxcvbn](https://stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid
|
@@ -803,7 +803,7 @@ module StytchB2B
|
|
803
803
|
# The Member's elected new password.
|
804
804
|
# The type of this field is +String+.
|
805
805
|
# organization_id::
|
806
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
806
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
807
807
|
# The type of this field is +String+.
|
808
808
|
# session_token::
|
809
809
|
# A secret token for a given Stytch Session.
|
@@ -20,7 +20,7 @@ module StytchB2B
|
|
20
20
|
#
|
21
21
|
# == Parameters:
|
22
22
|
# organization_id::
|
23
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
23
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
24
24
|
# The type of this field is +String+.
|
25
25
|
# member_id::
|
26
26
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -114,7 +114,7 @@ module StytchB2B
|
|
114
114
|
#
|
115
115
|
# == Parameters:
|
116
116
|
# organization_id::
|
117
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
117
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
118
118
|
# The type of this field is +String+.
|
119
119
|
# member_id::
|
120
120
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -154,7 +154,7 @@ module StytchB2B
|
|
154
154
|
#
|
155
155
|
# == Parameters:
|
156
156
|
# organization_id::
|
157
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
157
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
158
158
|
# The type of this field is +String+.
|
159
159
|
# member_id::
|
160
160
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
data/lib/stytch/b2b_scim.rb
CHANGED
@@ -182,7 +182,7 @@ module StytchB2B
|
|
182
182
|
#
|
183
183
|
# == Parameters:
|
184
184
|
# organization_id::
|
185
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
185
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
186
186
|
# The type of this field is +String+.
|
187
187
|
# connection_id::
|
188
188
|
# The ID of the SCIM connection.
|
@@ -233,7 +233,7 @@ module StytchB2B
|
|
233
233
|
#
|
234
234
|
# == Parameters:
|
235
235
|
# organization_id::
|
236
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
236
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
237
237
|
# The type of this field is +String+.
|
238
238
|
# connection_id::
|
239
239
|
# The ID of the SCIM connection.
|
@@ -267,7 +267,7 @@ module StytchB2B
|
|
267
267
|
#
|
268
268
|
# == Parameters:
|
269
269
|
# organization_id::
|
270
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
270
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
271
271
|
# The type of this field is +String+.
|
272
272
|
# connection_id::
|
273
273
|
# The ID of the SCIM connection.
|
@@ -303,7 +303,7 @@ module StytchB2B
|
|
303
303
|
#
|
304
304
|
# == Parameters:
|
305
305
|
# organization_id::
|
306
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
306
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
307
307
|
# The type of this field is +String+.
|
308
308
|
# connection_id::
|
309
309
|
# The ID of the SCIM connection.
|
@@ -339,7 +339,7 @@ module StytchB2B
|
|
339
339
|
#
|
340
340
|
# == Parameters:
|
341
341
|
# organization_id::
|
342
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
342
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
343
343
|
# The type of this field is +String+.
|
344
344
|
# connection_id::
|
345
345
|
# The ID of the SCIM connection.
|
@@ -375,7 +375,7 @@ module StytchB2B
|
|
375
375
|
#
|
376
376
|
# == Parameters:
|
377
377
|
# organization_id::
|
378
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
378
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
379
379
|
# The type of this field is +String+.
|
380
380
|
# connection_id::
|
381
381
|
# The ID of the SCIM connection.
|
@@ -422,7 +422,7 @@ module StytchB2B
|
|
422
422
|
#
|
423
423
|
# == Parameters:
|
424
424
|
# organization_id::
|
425
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
425
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
426
426
|
# The type of this field is +String+.
|
427
427
|
# display_name::
|
428
428
|
# A human-readable display name for the connection.
|
@@ -464,7 +464,7 @@ module StytchB2B
|
|
464
464
|
#
|
465
465
|
# == Parameters:
|
466
466
|
# organization_id::
|
467
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
467
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
468
468
|
# The type of this field is +String+.
|
469
469
|
#
|
470
470
|
# == Returns:
|
data/lib/stytch/b2b_sessions.rb
CHANGED
@@ -57,7 +57,7 @@ module StytchB2B
|
|
57
57
|
#
|
58
58
|
# == Parameters:
|
59
59
|
# organization_id::
|
60
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
60
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
61
61
|
# The type of this field is +String+.
|
62
62
|
# member_id::
|
63
63
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -248,7 +248,7 @@ module StytchB2B
|
|
248
248
|
#
|
249
249
|
# == Parameters:
|
250
250
|
# organization_id::
|
251
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
251
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
252
252
|
# The type of this field is +String+.
|
253
253
|
# session_token::
|
254
254
|
# The `session_token` belonging to the member that you wish to associate the email with.
|
@@ -513,7 +513,7 @@ module StytchB2B
|
|
513
513
|
# The authorization token Stytch will pass in to the external userinfo endpoint.
|
514
514
|
# The type of this field is +String+.
|
515
515
|
# organization_id::
|
516
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
516
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
517
517
|
# The type of this field is +String+.
|
518
518
|
# session_duration_minutes::
|
519
519
|
# Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,
|
data/lib/stytch/b2b_sso.rb
CHANGED
@@ -63,7 +63,7 @@ module StytchB2B
|
|
63
63
|
#
|
64
64
|
# == Parameters:
|
65
65
|
# organization_id::
|
66
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
66
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
67
67
|
# The type of this field is +String+.
|
68
68
|
#
|
69
69
|
# == Returns:
|
@@ -101,7 +101,7 @@ module StytchB2B
|
|
101
101
|
#
|
102
102
|
# == Parameters:
|
103
103
|
# organization_id::
|
104
|
-
# The organization ID that the SSO connection belongs to. You may also use the organization_slug here as a convenience.
|
104
|
+
# The organization ID that the SSO connection belongs to. You may also use the organization_slug or organization_external_id here as a convenience.
|
105
105
|
# The type of this field is +String+.
|
106
106
|
# connection_id::
|
107
107
|
# The ID of the SSO connection. SAML, OIDC, and External connection IDs can be provided.
|
@@ -307,7 +307,7 @@ module StytchB2B
|
|
307
307
|
#
|
308
308
|
# == Parameters:
|
309
309
|
# organization_id::
|
310
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
310
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
311
311
|
# The type of this field is +String+.
|
312
312
|
# display_name::
|
313
313
|
# A human-readable display name for the connection.
|
@@ -368,7 +368,7 @@ module StytchB2B
|
|
368
368
|
#
|
369
369
|
# == Parameters:
|
370
370
|
# organization_id::
|
371
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
371
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
372
372
|
# The type of this field is +String+.
|
373
373
|
# connection_id::
|
374
374
|
# Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
|
@@ -548,7 +548,7 @@ module StytchB2B
|
|
548
548
|
#
|
549
549
|
# == Parameters:
|
550
550
|
# organization_id::
|
551
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
551
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
552
552
|
# The type of this field is +String+.
|
553
553
|
# display_name::
|
554
554
|
# A human-readable display name for the connection.
|
@@ -598,7 +598,7 @@ module StytchB2B
|
|
598
598
|
#
|
599
599
|
# == Parameters:
|
600
600
|
# organization_id::
|
601
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
601
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
602
602
|
# The type of this field is +String+.
|
603
603
|
# connection_id::
|
604
604
|
# Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
|
@@ -711,7 +711,7 @@ module StytchB2B
|
|
711
711
|
#
|
712
712
|
# == Parameters:
|
713
713
|
# organization_id::
|
714
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
714
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
715
715
|
# The type of this field is +String+.
|
716
716
|
# connection_id::
|
717
717
|
# Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
|
@@ -755,7 +755,7 @@ module StytchB2B
|
|
755
755
|
#
|
756
756
|
# == Parameters:
|
757
757
|
# organization_id::
|
758
|
-
# The organization ID that the SAML connection belongs to. You may also use the organization_slug here as a convenience.
|
758
|
+
# The organization ID that the SAML connection belongs to. You may also use the organization_slug or organization_external_id here as a convenience.
|
759
759
|
# The type of this field is +String+.
|
760
760
|
# connection_id::
|
761
761
|
# The ID of the SAML connection.
|
@@ -839,7 +839,7 @@ module StytchB2B
|
|
839
839
|
#
|
840
840
|
# == Parameters:
|
841
841
|
# organization_id::
|
842
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
842
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
843
843
|
# The type of this field is +String+.
|
844
844
|
# external_organization_id::
|
845
845
|
# Globally unique UUID that identifies a different Organization within your Project.
|
@@ -897,7 +897,7 @@ module StytchB2B
|
|
897
897
|
#
|
898
898
|
# == Parameters:
|
899
899
|
# organization_id::
|
900
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
900
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
901
901
|
# The type of this field is +String+.
|
902
902
|
# connection_id::
|
903
903
|
# Globally unique UUID that identifies a specific External SSO Connection.
|
data/lib/stytch/b2b_totps.rb
CHANGED
@@ -24,7 +24,7 @@ module StytchB2B
|
|
24
24
|
#
|
25
25
|
# == Parameters:
|
26
26
|
# organization_id::
|
27
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
27
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
28
28
|
# The type of this field is +String+.
|
29
29
|
# member_id::
|
30
30
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -96,7 +96,7 @@ module StytchB2B
|
|
96
96
|
#
|
97
97
|
# == Parameters:
|
98
98
|
# organization_id::
|
99
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
99
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
100
100
|
# The type of this field is +String+.
|
101
101
|
# member_id::
|
102
102
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
@@ -202,7 +202,7 @@ module StytchB2B
|
|
202
202
|
#
|
203
203
|
# == Parameters:
|
204
204
|
# organization_id::
|
205
|
-
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug here as a convenience.
|
205
|
+
# Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience.
|
206
206
|
# The type of this field is +String+.
|
207
207
|
# member_id::
|
208
208
|
# Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member.
|
data/lib/stytch/passwords.rb
CHANGED
@@ -116,7 +116,7 @@ module Stytch
|
|
116
116
|
|
117
117
|
# Authenticate a user with their email address and password. This endpoint verifies that the user has a password currently set, and that the entered password is correct. There are two instances where the endpoint will return a `reset_password` error even if they enter their previous password:
|
118
118
|
#
|
119
|
-
# **One:** The user
|
119
|
+
# **One:** The user's credentials appeared in the HaveIBeenPwned dataset. We force a password reset to ensure that the user is the legitimate owner of the email address, and not a malicious actor abusing the compromised credentials.
|
120
120
|
#
|
121
121
|
# **Two:** A user that has previously authenticated with email/password uses a passwordless authentication method tied to the same email address (e.g. Magic Links, Google OAuth) for the first time. Any subsequent email/password authentication attempt will result in this error. We force a password reset in this instance in order to safely deduplicate the account by email address, without introducing the risk of a pre-hijack account takeover attack.
|
122
122
|
#
|
@@ -462,7 +462,7 @@ module Stytch
|
|
462
462
|
post_request('/v1/passwords/email/reset/start', request, headers)
|
463
463
|
end
|
464
464
|
|
465
|
-
# Reset the user
|
465
|
+
# Reset the user's password and authenticate them. This endpoint checks that the magic link `token` is valid, hasn't expired, or already been used – and can optionally require additional security settings, such as the IP address and user agent matching the initial reset request.
|
466
466
|
#
|
467
467
|
# The provided password needs to meet our password strength requirements, which can be checked in advance with the password strength endpoint. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.
|
468
468
|
#
|
@@ -572,7 +572,7 @@ module Stytch
|
|
572
572
|
@connection = connection
|
573
573
|
end
|
574
574
|
|
575
|
-
# Reset the User
|
575
|
+
# Reset the User's password using their existing password.
|
576
576
|
#
|
577
577
|
# Note that a successful password reset via an existing password will revoke all active sessions for the `user_id`.
|
578
578
|
#
|
data/lib/stytch/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: stytch
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 10.
|
4
|
+
version: 10.27.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- stytch
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-08-
|
11
|
+
date: 2025-08-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|