stytch 7.5.0 → 7.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aed7b76ec8534b96ef77dc7ad399a39f1644481dd7604282b4b549c4047d8722
4
- data.tar.gz: d92f3ff95e481c60539490793e13fda5d4467d6bbc70a0235dff6cb850635ae8
3
+ metadata.gz: 20081a47ace39be10d26c1e1aa897a2dd6a92af8033e4248cb0c0b0ab8423f20
4
+ data.tar.gz: e78cd3c76f31a2d7c186adbe92cc86b1aef074e8c2e054f871afe3a7fadb8087
5
5
  SHA512:
6
- metadata.gz: 46152089296e2224c0713ddf761a85d5a431228b01367e6df79b273089259e6be6ff1f36910fd2857609b0528eb1d868797f1d2c865afcb1f11929842cd1d4ed
7
- data.tar.gz: 6857b8e5a18e7435cf4b7093598e5ee6596dffba9125e18d84689f48d32c90060b09ab84867da4b19eebfb0b0327ce1f000eda1dd18d10462ce7811762a9a2fe
6
+ metadata.gz: e3945334acf409cebd4574c3537f5db421708ccf0f4e739fce4199af0697a65ff9aad3d80f3be995d05fbaf12a49a094c04ae9221547d9b11e9bbc9db3d6ae43
7
+ data.tar.gz: 61852bbbf716eb468c5cd3c222218dce2e6be285af330046e1a05b91d858660c6d7b3fbc3ee2c72984e38fbdf52742e1a3e3509c14af3b79e5943eed24d37991
@@ -8,6 +8,7 @@ require_relative 'b2b_otp'
8
8
  require_relative 'b2b_passwords'
9
9
  require_relative 'b2b_rbac'
10
10
  require_relative 'b2b_recovery_codes'
11
+ require_relative 'b2b_scim'
11
12
  require_relative 'b2b_sessions'
12
13
  require_relative 'b2b_sso'
13
14
  require_relative 'b2b_totps'
@@ -18,7 +19,7 @@ module StytchB2B
18
19
  class Client
19
20
  ENVIRONMENTS = %i[live test].freeze
20
21
 
21
- attr_reader :discovery, :m2m, :magic_links, :oauth, :otps, :organizations, :passwords, :rbac, :recovery_codes, :sso, :sessions, :totps
22
+ attr_reader :discovery, :m2m, :magic_links, :oauth, :otps, :organizations, :passwords, :rbac, :recovery_codes, :scim, :sso, :sessions, :totps
22
23
 
23
24
  def initialize(project_id:, secret:, env: nil, &block)
24
25
  @api_host = api_host(env, project_id)
@@ -39,6 +40,7 @@ module StytchB2B
39
40
  @passwords = StytchB2B::Passwords.new(@connection)
40
41
  @rbac = StytchB2B::RBAC.new(@connection)
41
42
  @recovery_codes = StytchB2B::RecoveryCodes.new(@connection)
43
+ @scim = StytchB2B::SCIM.new(@connection)
42
44
  @sso = StytchB2B::SSO.new(@connection)
43
45
  @sessions = StytchB2B::Sessions.new(@connection, @project_id, @policy_cache)
44
46
  @totps = StytchB2B::TOTPs.new(@connection)
@@ -40,11 +40,7 @@ module StytchB2B
40
40
  #
41
41
  # == Parameters:
42
42
  # intermediate_session_token::
43
- # 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.
44
- # 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),
45
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
46
- # 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;
47
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
43
+ # 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. 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.
48
44
  # The type of this field is +String+.
49
45
  # organization_id::
50
46
  # 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.
@@ -102,11 +98,7 @@ module StytchB2B
102
98
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
103
99
  # The type of this field is +Boolean+.
104
100
  # intermediate_session_token::
105
- # The returned Intermediate Session Token is identical to the one that was originally passed in to the request.
106
- # 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),
107
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
108
- # It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization,
109
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
101
+ # The returned Intermediate Session Token is identical to the one that was originally passed in to the request. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. 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.
110
102
  # The type of this field is +String+.
111
103
  # status_code::
112
104
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
@@ -165,11 +157,7 @@ module StytchB2B
165
157
  #
166
158
  # == Parameters:
167
159
  # intermediate_session_token::
168
- # 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.
169
- # 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),
170
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
171
- # 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;
172
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
160
+ # 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. 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.
173
161
  # The type of this field is +String+.
174
162
  # organization_name::
175
163
  # The name of the Organization. If the name is not specified, a default name will be created based on the email used to initiate the discovery flow. If the email domain is a common email provider such as gmail.com, or if the email is a .edu email, the organization name will be generated based on the name portion of the email. Otherwise, the organization name will be generated based on the email domain.
@@ -297,11 +285,7 @@ module StytchB2B
297
285
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
298
286
  # The type of this field is +Boolean+.
299
287
  # intermediate_session_token::
300
- # The returned Intermediate Session Token is identical to the one that was originally passed in to the request.
301
- # 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),
302
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
303
- # It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization,
304
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
288
+ # The returned Intermediate Session Token is identical to the one that was originally passed in to the request. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. 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.
305
289
  # The type of this field is +String+.
306
290
  # status_code::
307
291
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
@@ -377,11 +361,7 @@ module StytchB2B
377
361
  #
378
362
  # == Parameters:
379
363
  # intermediate_session_token::
380
- # 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.
381
- # 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),
382
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
383
- # 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;
384
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
364
+ # 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. 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.
385
365
  # The type of this field is nilable +String+.
386
366
  # session_token::
387
367
  # A secret token for a given Stytch Session.
@@ -77,7 +77,7 @@ module StytchB2B
77
77
  #
78
78
  # The type of this field is nilable +AuthenticateRequestLocale+ (string enum).
79
79
  # intermediate_session_token::
80
- # (no documentation yet)
80
+ # Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization's primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned.
81
81
  # The type of this field is nilable +String+.
82
82
  #
83
83
  # == Returns:
@@ -114,11 +114,7 @@ module StytchB2B
114
114
  # The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
115
115
  # The type of this field is +Organization+ (+object+).
116
116
  # intermediate_session_token::
117
- # The returned Intermediate Session Token contains an Email Magic Link factor associated with the Member's email address.
118
- # 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),
119
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
120
- # It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization that allows login with Email Magic Links,
121
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
117
+ # The returned Intermediate Session Token contains an Email Magic Link factor associated with the Member's email address. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. 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.
122
118
  # The type of this field is +String+.
123
119
  # member_authenticated::
124
120
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -430,11 +426,7 @@ module StytchB2B
430
426
  # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
431
427
  # The type of this field is +String+.
432
428
  # intermediate_session_token::
433
- # 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.
434
- # 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),
435
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
436
- # 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;
437
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
429
+ # 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. 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.
438
430
  # The type of this field is +String+.
439
431
  # email_address::
440
432
  # The email address.
@@ -72,7 +72,7 @@ module StytchB2B
72
72
  #
73
73
  # The type of this field is nilable +AuthenticateRequestLocale+ (string enum).
74
74
  # intermediate_session_token::
75
- # (no documentation yet)
75
+ # Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization's primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned.
76
76
  # The type of this field is nilable +String+.
77
77
  #
78
78
  # == Returns:
@@ -111,11 +111,7 @@ module StytchB2B
111
111
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
112
112
  # The type of this field is +Boolean+.
113
113
  # intermediate_session_token::
114
- # The returned Intermediate Session Token contains an OAuth factor associated with the Member's email address.
115
- # 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),
116
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
117
- # It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization that allows login with OAuth,
118
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
114
+ # The returned Intermediate Session Token contains an OAuth factor associated with the Member's email address. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. 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.
119
115
  # The type of this field is +String+.
120
116
  # status_code::
121
117
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
@@ -194,11 +190,7 @@ module StytchB2B
194
190
  # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
195
191
  # The type of this field is +String+.
196
192
  # intermediate_session_token::
197
- # 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.
198
- # 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),
199
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
200
- # 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;
201
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
193
+ # 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. 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.
202
194
  # The type of this field is +String+.
203
195
  # email_address::
204
196
  # The email address.
@@ -534,8 +534,7 @@ module StytchB2B
534
534
  # name::
535
535
  # The name of the Member.
536
536
  #
537
- # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.name` action on the `stytch.member` Resource.
538
- # Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.name` action on the `stytch.self` Resource.
537
+ # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.name` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.name` action on the `stytch.self` Resource.
539
538
  # The type of this field is nilable +String+.
540
539
  # trusted_metadata::
541
540
  # An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
@@ -547,8 +546,7 @@ module StytchB2B
547
546
  # frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata)
548
547
  # for complete field behavior details.
549
548
  #
550
- # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.untrusted-metadata` action on the `stytch.member` Resource.
551
- # Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.untrusted-metadata` action on the `stytch.self` Resource.
549
+ # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.untrusted-metadata` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.untrusted-metadata` action on the `stytch.self` Resource.
552
550
  # The type of this field is nilable +object+.
553
551
  # is_breakglass::
554
552
  # Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures. Refer to the [Organization object](organization-object) and its `auth_methods` and `allowed_auth_methods` fields for more details.
@@ -558,14 +556,12 @@ module StytchB2B
558
556
  # mfa_phone_number::
559
557
  # Sets the Member's phone number. Throws an error if the Member already has a phone number. To change the Member's phone number, use the [Delete member phone number endpoint](https://stytch.com/docs/b2b/api/delete-member-mfa-phone-number) to delete the Member's existing phone number first.
560
558
  #
561
- # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.mfa-phone` action on the `stytch.member` Resource.
562
- # Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.mfa-phone` action on the `stytch.self` Resource.
559
+ # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.info.mfa-phone` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.info.mfa-phone` action on the `stytch.self` Resource.
563
560
  # The type of this field is nilable +String+.
564
561
  # mfa_enrolled::
565
562
  # Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to `REQUIRED_FOR_ALL`.
566
563
  #
567
- # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.mfa-enrolled` action on the `stytch.member` Resource.
568
- # Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.mfa-enrolled` action on the `stytch.self` Resource.
564
+ # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.mfa-enrolled` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.mfa-enrolled` action on the `stytch.self` Resource.
569
565
  # The type of this field is nilable +Boolean+.
570
566
  # roles::
571
567
  # Roles to explicitly assign to this Member.
@@ -587,8 +583,7 @@ module StytchB2B
587
583
  # default_mfa_method::
588
584
  # Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to `REQUIRED_FOR_ALL`.
589
585
  #
590
- # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.default-mfa-method` action on the `stytch.member` Resource.
591
- # Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.default-mfa-method` action on the `stytch.self` Resource.
586
+ # If this field is provided and a session header is passed into the request, the Member Session must have permission to perform the `update.settings.default-mfa-method` action on the `stytch.member` Resource. Alternatively, if the Member Session matches the Member associated with the `member_id` passed in the request, the authorization check will also allow a Member Session that has permission to perform the `update.settings.default-mfa-method` action on the `stytch.self` Resource.
592
587
  # The type of this field is nilable +String+.
593
588
  # email_address::
594
589
  # Updates the Member's `email_address`, if provided.
@@ -1079,7 +1074,7 @@ module StytchB2B
1079
1074
  # 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.
1080
1075
  # The type of this field is +String+.
1081
1076
  # include_refresh_token::
1082
- # (no documentation yet)
1077
+ # Whether to return the refresh token Stytch has stored for the OAuth Provider. Defaults to false. **Important:** If your application exchanges the refresh token, Stytch may not be able to automatically refresh access tokens in the future.
1083
1078
  # The type of this field is nilable +Boolean+.
1084
1079
  #
1085
1080
  # == Returns:
@@ -1109,7 +1104,7 @@ module StytchB2B
1109
1104
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
1110
1105
  # The type of this field is +Integer+.
1111
1106
  # refresh_token::
1112
- # (no documentation yet)
1107
+ # The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API.
1113
1108
  # The type of this field is nilable +String+.
1114
1109
  def google(
1115
1110
  organization_id:,
@@ -1136,7 +1131,7 @@ module StytchB2B
1136
1131
  # 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.
1137
1132
  # The type of this field is +String+.
1138
1133
  # include_refresh_token::
1139
- # (no documentation yet)
1134
+ # Whether to return the refresh token Stytch has stored for the OAuth Provider. Defaults to false. **Important:** If your application exchanges the refresh token, Stytch may not be able to automatically refresh access tokens in the future.
1140
1135
  # The type of this field is nilable +Boolean+.
1141
1136
  #
1142
1137
  # == Returns:
@@ -1166,7 +1161,7 @@ module StytchB2B
1166
1161
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
1167
1162
  # The type of this field is +Integer+.
1168
1163
  # refresh_token::
1169
- # (no documentation yet)
1164
+ # The `refresh_token` that you may use to obtain a new `access_token` for the User within the provider's API.
1170
1165
  # The type of this field is nilable +String+.
1171
1166
  def microsoft(
1172
1167
  organization_id:,
@@ -65,11 +65,7 @@ module StytchB2B
65
65
  #
66
66
  # The type of this field is nilable +SendRequestLocale+ (string enum).
67
67
  # intermediate_session_token::
68
- # 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.
69
- # 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),
70
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
71
- # 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;
72
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
68
+ # 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. 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.
73
69
  # The type of this field is nilable +String+.
74
70
  # session_token::
75
71
  # A secret token for a given Stytch Session.
@@ -146,11 +142,7 @@ module StytchB2B
146
142
  # The code to authenticate.
147
143
  # The type of this field is +String+.
148
144
  # intermediate_session_token::
149
- # 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.
150
- # 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),
151
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
152
- # 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;
153
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
145
+ # 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. 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.
154
146
  # The type of this field is nilable +String+.
155
147
  # session_token::
156
148
  # A secret token for a given Stytch Session.
@@ -256,7 +256,7 @@ module StytchB2B
256
256
  #
257
257
  # The type of this field is nilable +AuthenticateRequestLocale+ (string enum).
258
258
  # intermediate_session_token::
259
- # (no documentation yet)
259
+ # Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization's primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned.
260
260
  # The type of this field is nilable +String+.
261
261
  #
262
262
  # == Returns:
@@ -283,10 +283,7 @@ module StytchB2B
283
283
  # The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
284
284
  # The type of this field is +Organization+ (+object+).
285
285
  # intermediate_session_token::
286
- # The returned Intermediate Session Token contains a password factor associated with the Member.
287
- # 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),
288
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
289
- # Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
286
+ # The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
290
287
  # The type of this field is +String+.
291
288
  # member_authenticated::
292
289
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -479,7 +476,7 @@ module StytchB2B
479
476
  #
480
477
  # The type of this field is nilable +ResetRequestLocale+ (string enum).
481
478
  # intermediate_session_token::
482
- # (no documentation yet)
479
+ # Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization's primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned.
483
480
  # The type of this field is nilable +String+.
484
481
  #
485
482
  # == Returns:
@@ -509,10 +506,7 @@ module StytchB2B
509
506
  # The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
510
507
  # The type of this field is +Organization+ (+object+).
511
508
  # intermediate_session_token::
512
- # The returned Intermediate Session Token contains a password factor associated with the Member.
513
- # 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),
514
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
515
- # Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
509
+ # The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
516
510
  # The type of this field is +String+.
517
511
  # member_authenticated::
518
512
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -624,11 +618,7 @@ module StytchB2B
624
618
  # The JSON Web Token (JWT) for a given Stytch Session.
625
619
  # The type of this field is +String+.
626
620
  # intermediate_session_token::
627
- # 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.
628
- # 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),
629
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
630
- # 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;
631
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
621
+ # 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. 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.
632
622
  # The type of this field is +String+.
633
623
  # member_authenticated::
634
624
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -756,10 +746,7 @@ module StytchB2B
756
746
  # The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
757
747
  # The type of this field is +Organization+ (+object+).
758
748
  # intermediate_session_token::
759
- # The returned Intermediate Session Token contains a password factor associated with the Member.
760
- # 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),
761
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
762
- # Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
749
+ # The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
763
750
  # The type of this field is +String+.
764
751
  # member_authenticated::
765
752
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -29,11 +29,7 @@ module StytchB2B
29
29
  # The recovery code generated by a secondary MFA method. This code is used to authenticate in place of the secondary MFA method if that method as a backup.
30
30
  # The type of this field is +String+.
31
31
  # intermediate_session_token::
32
- # 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.
33
- # 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),
34
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
35
- # 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;
36
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
32
+ # 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. 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.
37
33
  # The type of this field is nilable +String+.
38
34
  # session_token::
39
35
  # A secret token for a given Stytch Session.
@@ -0,0 +1,262 @@
1
+ # frozen_string_literal: true
2
+
3
+ # !!!
4
+ # WARNING: This file is autogenerated
5
+ # Only modify code within MANUAL() sections
6
+ # or your changes may be overwritten later!
7
+ # !!!
8
+
9
+ require_relative 'request_helper'
10
+
11
+ module StytchB2B
12
+ class SCIM
13
+ include Stytch::RequestHelper
14
+ attr_reader :connections
15
+
16
+ def initialize(connection)
17
+ @connection = connection
18
+
19
+ @connections = StytchB2B::SCIM::Connections.new(@connection)
20
+ end
21
+
22
+ class Connections
23
+ include Stytch::RequestHelper
24
+
25
+ def initialize(connection)
26
+ @connection = connection
27
+ end
28
+
29
+ # Update a SCIM Connection. /%}
30
+ #
31
+ # == Parameters:
32
+ # organization_id::
33
+ # 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.
34
+ # The type of this field is +String+.
35
+ # connection_id::
36
+ # The ID of the SCIM connection.
37
+ # The type of this field is +String+.
38
+ # display_name::
39
+ # A human-readable display name for the connection.
40
+ # The type of this field is nilable +String+.
41
+ # identity_provider::
42
+ # (no documentation yet)
43
+ # The type of this field is nilable +UpdateRequestIdp+ (string enum).
44
+ # scim_group_implicit_role_assignments::
45
+ # (no documentation yet)
46
+ # The type of this field is nilable list of +SCIMGroupImplicitRoleAssignments+.
47
+ #
48
+ # == Returns:
49
+ # An object with the following fields:
50
+ # request_id::
51
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
52
+ # The type of this field is +String+.
53
+ # status_code::
54
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
55
+ # The type of this field is +Integer+.
56
+ # connection::
57
+ # The `SAML Connection` object affected by this API call. See the [SAML Connection Object](https://stytch.com/docs/b2b/api/saml-connection-object) for complete response field details.
58
+ # The type of this field is nilable +SCIMConnection+ (+object+).
59
+ def update(
60
+ organization_id:,
61
+ connection_id:,
62
+ display_name: nil,
63
+ identity_provider: nil,
64
+ scim_group_implicit_role_assignments: nil
65
+ )
66
+ headers = {}
67
+ request = {}
68
+ request[:display_name] = display_name unless display_name.nil?
69
+ request[:identity_provider] = identity_provider unless identity_provider.nil?
70
+ request[:scim_group_implicit_role_assignments] = scim_group_implicit_role_assignments unless scim_group_implicit_role_assignments.nil?
71
+
72
+ put_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}", request, headers)
73
+ end
74
+
75
+ # Deletes a SCIM Connection. /%}
76
+ #
77
+ # == Parameters:
78
+ # organization_id::
79
+ # 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.
80
+ # The type of this field is +String+.
81
+ # connection_id::
82
+ # Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
83
+ # The type of this field is +String+.
84
+ #
85
+ # == Returns:
86
+ # An object with the following fields:
87
+ # request_id::
88
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
89
+ # The type of this field is +String+.
90
+ # connection_id::
91
+ # The `connection_id` that was deleted as part of the delete request.
92
+ # The type of this field is +String+.
93
+ # status_code::
94
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
95
+ # The type of this field is +Integer+.
96
+ def delete(
97
+ organization_id:,
98
+ connection_id:
99
+ )
100
+ headers = {}
101
+ delete_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}", headers)
102
+ end
103
+
104
+ # Start a SCIM token rotation. /%}
105
+ #
106
+ # == Parameters:
107
+ # organization_id::
108
+ # 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.
109
+ # The type of this field is +String+.
110
+ # connection_id::
111
+ # The ID of the SCIM connection.
112
+ # The type of this field is +String+.
113
+ #
114
+ # == Returns:
115
+ # An object with the following fields:
116
+ # request_id::
117
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
118
+ # The type of this field is +String+.
119
+ # status_code::
120
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
121
+ # The type of this field is +Integer+.
122
+ # connection::
123
+ # The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
124
+ # The type of this field is nilable +SCIMConnectionWithNextToken+ (+object+).
125
+ def rotate_start(
126
+ organization_id:,
127
+ connection_id:
128
+ )
129
+ headers = {}
130
+ request = {}
131
+
132
+ post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/start", request, headers)
133
+ end
134
+
135
+ # Completes a SCIM token rotation. This will complete the current token rotation process and update the active token to be the new token supplied in the [start SCIM token rotation](https://stytch.com/docs/b2b/api/scim-rotate-token-start) response. /%}
136
+ #
137
+ # == Parameters:
138
+ # organization_id::
139
+ # 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.
140
+ # The type of this field is +String+.
141
+ # connection_id::
142
+ # The ID of the SCIM connection.
143
+ # The type of this field is +String+.
144
+ #
145
+ # == Returns:
146
+ # An object with the following fields:
147
+ # request_id::
148
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
149
+ # The type of this field is +String+.
150
+ # status_code::
151
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
152
+ # The type of this field is +Integer+.
153
+ # connection::
154
+ # The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
155
+ # The type of this field is nilable +SCIMConnection+ (+object+).
156
+ def rotate_complete(
157
+ organization_id:,
158
+ connection_id:
159
+ )
160
+ headers = {}
161
+ request = {}
162
+
163
+ post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/complete", request, headers)
164
+ end
165
+
166
+ # Cancel a SCIM token rotation. This will cancel the current token rotation process, keeping the original token active. /%}
167
+ #
168
+ # == Parameters:
169
+ # organization_id::
170
+ # 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.
171
+ # The type of this field is +String+.
172
+ # connection_id::
173
+ # The ID of the SCIM connection.
174
+ # The type of this field is +String+.
175
+ #
176
+ # == Returns:
177
+ # An object with the following fields:
178
+ # request_id::
179
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
180
+ # The type of this field is +String+.
181
+ # status_code::
182
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
183
+ # The type of this field is +Integer+.
184
+ # connection::
185
+ # The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
186
+ # The type of this field is nilable +SCIMConnection+ (+object+).
187
+ def rotate_cancel(
188
+ organization_id:,
189
+ connection_id:
190
+ )
191
+ headers = {}
192
+ request = {}
193
+
194
+ post_request("/v1/b2b/scim/#{organization_id}/connections/#{connection_id}/rotate/cancel", request, headers)
195
+ end
196
+
197
+ # Create a new SCIM Connection. /%}
198
+ #
199
+ # == Parameters:
200
+ # organization_id::
201
+ # 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.
202
+ # The type of this field is +String+.
203
+ # display_name::
204
+ # A human-readable display name for the connection.
205
+ # The type of this field is nilable +String+.
206
+ # identity_provider::
207
+ # (no documentation yet)
208
+ # The type of this field is nilable +CreateRequestIdp+ (string enum).
209
+ #
210
+ # == Returns:
211
+ # An object with the following fields:
212
+ # request_id::
213
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
214
+ # The type of this field is +String+.
215
+ # status_code::
216
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
217
+ # The type of this field is +Integer+.
218
+ # connection::
219
+ # The `SCIM Connection` object affected by this API call. See the [SCIM Connection Object](https://stytch.com/docs/b2b/api/scim-connection-object) for complete response field details.
220
+ # The type of this field is nilable +SCIMConnectionWithToken+ (+object+).
221
+ def create(
222
+ organization_id:,
223
+ display_name: nil,
224
+ identity_provider: nil
225
+ )
226
+ headers = {}
227
+ request = {}
228
+ request[:display_name] = display_name unless display_name.nil?
229
+ request[:identity_provider] = identity_provider unless identity_provider.nil?
230
+
231
+ post_request("/v1/b2b/scim/#{organization_id}/connections", request, headers)
232
+ end
233
+
234
+ # Get SCIM Connections. /%}
235
+ #
236
+ # == Parameters:
237
+ # organization_id::
238
+ # 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.
239
+ # The type of this field is +String+.
240
+ #
241
+ # == Returns:
242
+ # An object with the following fields:
243
+ # request_id::
244
+ # Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
245
+ # The type of this field is +String+.
246
+ # connections::
247
+ # (no documentation yet)
248
+ # The type of this field is list of +SCIMConnection+ (+object+).
249
+ # status_code::
250
+ # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
251
+ # The type of this field is +Integer+.
252
+ def get(
253
+ organization_id:
254
+ )
255
+ headers = {}
256
+ query_params = {}
257
+ request = request_with_query_params("/v1/b2b/scim/#{organization_id}/connections", query_params)
258
+ get_request(request, headers)
259
+ end
260
+ end
261
+ end
262
+ end
@@ -284,11 +284,7 @@ module StytchB2B
284
284
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
285
285
  # The type of this field is +Boolean+.
286
286
  # intermediate_session_token::
287
- # The returned Intermediate Session Token contains any Email Magic Link or OAuth factors from the original member session that are valid for the target Organization.
288
- # 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),
289
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the target Organization.
290
- # It can also be used with the [Exchange Intermediate Session endpoint](https://stytch.com/docs/b2b/api/exchange-intermediate-session) to join a different existing Organization,
291
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization.
287
+ # The returned Intermediate Session Token contains any Email Magic Link or OAuth factors from the original member session that are valid for the target Organization. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. 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.
292
288
  # The type of this field is +String+.
293
289
  # status_code::
294
290
  # The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
@@ -182,7 +182,7 @@ module StytchB2B
182
182
  #
183
183
  # The type of this field is nilable +AuthenticateRequestLocale+ (string enum).
184
184
  # intermediate_session_token::
185
- # (no documentation yet)
185
+ # Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization's primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned.
186
186
  # The type of this field is nilable +String+.
187
187
  #
188
188
  # == Returns:
@@ -213,10 +213,7 @@ module StytchB2B
213
213
  # The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
214
214
  # The type of this field is +Organization+ (+object+).
215
215
  # intermediate_session_token::
216
- # The returned Intermediate Session Token contains an SSO factor associated with the Member.
217
- # 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),
218
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete the MFA flow and log in to the Organization.
219
- # SSO factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
216
+ # The returned Intermediate Session Token contains an SSO factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. 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. SSO factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints.
220
217
  # The type of this field is +String+.
221
218
  # member_authenticated::
222
219
  # Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
@@ -31,11 +31,7 @@ module StytchB2B
31
31
  # The expiration for the TOTP registration. If the newly created TOTP registration is not authenticated within this time frame the member will have to restart the registration flow. Defaults to 60 (1 hour) with a minimum of 5 and a maximum of 1440.
32
32
  # The type of this field is nilable +Integer+.
33
33
  # intermediate_session_token::
34
- # 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.
35
- # 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),
36
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
37
- # 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;
38
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
34
+ # 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. 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.
39
35
  # The type of this field is nilable +String+.
40
36
  # session_token::
41
37
  # A secret token for a given Stytch Session.
@@ -107,11 +103,7 @@ module StytchB2B
107
103
  # The code to authenticate.
108
104
  # The type of this field is +String+.
109
105
  # intermediate_session_token::
110
- # 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.
111
- # 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),
112
- # or [Recovery Codes Recover endpoint](https://stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow;
113
- # 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;
114
- # or the [Create Organization via Discovery endpoint](https://stytch.com/docs/b2b/api/create-organization-via-discovery) to create a new Organization and Member.
106
+ # 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. 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.
115
107
  # The type of this field is nilable +String+.
116
108
  # session_token::
117
109
  # A secret token for a given Stytch Session.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Stytch
4
- VERSION = '7.5.0'
4
+ VERSION = '7.6.0'
5
5
  end
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: 7.5.0
4
+ version: 7.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - stytch
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-03-20 00:00:00.000000000 Z
11
+ date: 2024-04-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -133,6 +133,7 @@ files:
133
133
  - lib/stytch/b2b_passwords.rb
134
134
  - lib/stytch/b2b_rbac.rb
135
135
  - lib/stytch/b2b_recovery_codes.rb
136
+ - lib/stytch/b2b_scim.rb
136
137
  - lib/stytch/b2b_sessions.rb
137
138
  - lib/stytch/b2b_sso.rb
138
139
  - lib/stytch/b2b_totps.rb