Skip to content

Commit

Permalink
Retired Emails
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcook-stytch
jcook-stytch committed Jul 24, 2024
1 parent 27a7a50 commit e6def63
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 16 deletions.
1 change: 1 addition & 0 deletions lib/stytch/b2b_magic_links.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ def login_or_signup(
# Send an invite email to a new Member to join an Organization. The Member will be created with an `invited` status until they successfully authenticate. Sending invites to `pending` Members will update their status to `invited`. Sending invites to already `active` Members will return an error.
#
# The magic link invite will be valid for 1 week.
# /%}
#
# == Parameters:
# organization_id::
Expand Down
112 changes: 107 additions & 5 deletions lib/stytch/b2b_organizations.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ def get(
# Updates an Organization specified by `organization_id`. An Organization must always have at least one auth setting set to either `RESTRICTED` or `ALL_ALLOWED` in order to provision new Members.
#
# *See the [Organization authentication settings](https://stytch.com/docs/b2b/api/org-auth-settings) resource to learn more about fields like `email_jit_provisioning`, `email_invites`, `sso_jit_provisioning`, etc., and their behaviors.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -359,6 +360,12 @@ def get(
#
# 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.allowed-mfa-methods` action on the `stytch.organization` Resource.
# The type of this field is nilable list of +String+.
# oauth_tenant_jit_provisioning::
# (no documentation yet)
# The type of this field is nilable +String+.
# allowed_oauth_tenants::
# (no documentation yet)
# The type of this field is nilable +object+.
#
# == Returns:
# An object with the following fields:
Expand Down Expand Up @@ -392,6 +399,8 @@ def update(
rbac_email_implicit_role_assignments: nil,
mfa_methods: nil,
allowed_mfa_methods: nil,
oauth_tenant_jit_provisioning: nil,
allowed_oauth_tenants: nil,
method_options: nil
)
headers = {}
Expand All @@ -413,11 +422,13 @@ def update(
request[:rbac_email_implicit_role_assignments] = rbac_email_implicit_role_assignments unless rbac_email_implicit_role_assignments.nil?
request[:mfa_methods] = mfa_methods unless mfa_methods.nil?
request[:allowed_mfa_methods] = allowed_mfa_methods unless allowed_mfa_methods.nil?
request[:oauth_tenant_jit_provisioning] = oauth_tenant_jit_provisioning unless oauth_tenant_jit_provisioning.nil?
request[:allowed_oauth_tenants] = allowed_oauth_tenants unless allowed_oauth_tenants.nil?

put_request("/v1/b2b/organizations/#{organization_id}", request, headers)
end

# Deletes an Organization specified by `organization_id`. All Members of the Organization will also be deleted.
# Deletes an Organization specified by `organization_id`. All Members of the Organization will also be deleted. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -631,6 +642,25 @@ def to_headers
end
end

class UnlinkRetiredEmailRequestOptions
# Optional authorization object.
# Pass in an active Stytch Member session token or session JWT and the request
# will be run using that member's permissions.
attr_accessor :authorization

def initialize(
authorization: nil
)
@authorization = authorization
end

def to_headers
headers = {}
headers.merge!(@authorization.to_headers) if authorization
headers
end
end

class CreateRequestOptions
# Optional authorization object.
# Pass in an active Stytch Member session token or session JWT and the request
Expand Down Expand Up @@ -660,6 +690,7 @@ def initialize(connection)
end

# Updates a Member specified by `organization_id` and `member_id`.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -782,7 +813,7 @@ def update(
put_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}", request, headers)
end

# Deletes a Member specified by `organization_id` and `member_id`.
# Deletes a Member specified by `organization_id` and `member_id`. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -816,7 +847,7 @@ def delete(
delete_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}", headers)
end

# Reactivates a deleted Member's status and its associated email status (if applicable) to active, specified by `organization_id` and `member_id`.
# Reactivates a deleted Member's status and its associated email status (if applicable) to active, specified by `organization_id` and `member_id`. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -865,6 +896,7 @@ def reactivate(
# Existing Member Sessions that include a phone number authentication factor will not be revoked if the phone number is deleted, and MFA will not be enforced until the Member logs in again.
# If you wish to enforce MFA immediately after a phone number is deleted, you can do so by prompting the Member to enter a new phone number
# and calling the [OTP SMS send](https://stytch.com/docs/b2b/api/otp-sms-send) endpoint, then calling the [OTP SMS Authenticate](https://stytch.com/docs/b2b/api/authenticate-otp-sms) endpoint.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -909,6 +941,7 @@ def delete_mfa_phone_number(
# To mint a new registration for a Member, you must first call this endpoint to delete the existing registration.
#
# Existing Member Sessions that include the TOTP authentication factor will not be revoked if the registration is deleted, and MFA will not be enforced until the Member logs in again.
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -951,6 +984,7 @@ def delete_totp(
# Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting an empty `query` returns all non-deleted Members within the specified Organizations.
#
# *All fuzzy search filters require a minimum of three characters.
# /%}
#
# == Parameters:
# organization_ids::
Expand Down Expand Up @@ -1005,7 +1039,7 @@ def search(
post_request('/v1/b2b/organizations/members/search', request, headers)
end

# Delete a Member's password.
# Delete a Member's password. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -1078,7 +1112,75 @@ def dangerously_get(
get_request(request, headers)
end

# Creates a Member. An `organization_id` and `email_address` are required.
# Unlinks a retired email address from a Member specified by their `organization_id` and `member_id`. The email address
# to be retired can be identified in the request body by either its `email_id`, its `email_address`, or both. If using
# both identifiers they must refer to the same email.
#
# A previously active email address can be marked as retired in one of two ways:
#
# - It's replaced with a new primary email address during an explicit Member update.
# - A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the
# Member's primary email address and the old primary email address is retired.
#
# A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email
# addresses allows then to be subsequently re-used by other Organization Members. Retired email addresses can be viewed
# on the [Member object](https://stytch.com/docs/b2b/api/member-object).
# %}
#
# == Parameters:
# organization_id::
# 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.
# The type of this field is +String+.
# member_id::
# 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.
# The type of this field is +String+.
# email_id::
# The globally unique UUID of a Member's email.
# The type of this field is nilable +String+.
# email_address::
# The email address of the Member.
# The type of this field is nilable +String+.
#
# == Returns:
# An object with the following fields:
# request_id::
# 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.
# The type of this field is +String+.
# member_id::
# Globally unique UUID that identifies a specific Member.
# The type of this field is +String+.
# organization_id::
# 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.
# The type of this field is +String+.
# member::
# The [Member object](https://stytch.com/docs/b2b/api/member-object)
# The type of this field is +Member+ (+object+).
# organization::
# The [Organization object](https://stytch.com/docs/b2b/api/organization-object).
# The type of this field is +Organization+ (+object+).
# status_code::
# 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.
# The type of this field is +Integer+.
#
# == Method Options:
# This method supports an optional +StytchB2B::Organizations::Members::UnlinkRetiredEmailRequestOptions+ object which will modify the headers sent in the HTTP request.
def unlink_retired_email(
organization_id:,
member_id:,
email_id: nil,
email_address: nil,
method_options: nil
)
headers = {}
headers = headers.merge(method_options.to_headers) unless method_options.nil?
request = {}
request[:email_id] = email_id unless email_id.nil?
request[:email_address] = email_address unless email_address.nil?

post_request("/v1/b2b/organizations/#{organization_id}/members/#{member_id}/unlink_retired_email", request, headers)
end

# Creates a Member. An `organization_id` and `email_address` are required. /%}
#
# == Parameters:
# organization_id::
Expand Down
14 changes: 7 additions & 7 deletions lib/stytch/b2b_scim.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def initialize(connection)
@connection = connection
end

# Update a SCIM Connection.
# Update a SCIM Connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -229,7 +229,7 @@ def update(
put_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}", request, headers)
end

# Deletes a SCIM Connection.
# Deletes a SCIM Connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -263,7 +263,7 @@ def delete(
delete_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}", headers)
end

# Start a SCIM token rotation.
# Start a SCIM token rotation. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -299,7 +299,7 @@ def rotate_start(
post_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}/rotate/start", request, headers)
end

# 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.
# 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. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -335,7 +335,7 @@ def rotate_complete(
post_request("/v1/b2b/scim/#{organization_id}/connection/#{connection_id}/rotate/complete", request, headers)
end

# Cancel a SCIM token rotation. This will cancel the current token rotation process, keeping the original token active.
# Cancel a SCIM token rotation. This will cancel the current token rotation process, keeping the original token active. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -418,7 +418,7 @@ def get_groups(
get_request(request, headers)
end

# Create a new SCIM Connection.
# Create a new SCIM Connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -460,7 +460,7 @@ def create(
post_request("/v1/b2b/scim/#{organization_id}/connection", request, headers)
end

# Get SCIM Connections.
# Get SCIM Connections. /%}
#
# == Parameters:
# organization_id::
Expand Down
12 changes: 8 additions & 4 deletions lib/stytch/b2b_sso.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def initialize(connection)
@saml = StytchB2B::SSO::SAML.new(@connection)
end

# Get all SSO Connections owned by the organization.
# Get all SSO Connections owned by the organization. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -96,7 +96,7 @@ def get_connections(
get_request(request, headers)
end

# Delete an existing SSO connection.
# Delete an existing SSO connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -300,7 +300,7 @@ def initialize(connection)
@connection = connection
end

# Create a new OIDC Connection.
# Create a new OIDC Connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -360,6 +360,7 @@ def create_connection(
# * `token_url`
# * `userinfo_url`
# * `jwks_url`
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -527,7 +528,7 @@ def initialize(connection)
@connection = connection
end

# Create a new SAML Connection.
# Create a new SAML Connection. /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -576,6 +577,7 @@ def create_connection(
# * `attribute_mapping`
# * `idp_entity_id`
# * `x509_certificate`
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -668,6 +670,7 @@ def update_connection(
# * `idp_entity_id`
# * `x509_certificate`
# * `attribute_mapping` (must be supplied using [Update SAML Connection](update-saml-connection))
# /%}
#
# == Parameters:
# organization_id::
Expand Down Expand Up @@ -712,6 +715,7 @@ def update_by_url(
# Delete a SAML verification certificate.
#
# You may need to do this when rotating certificates from your IdP, since Stytch allows a maximum of 5 certificates per connection. There must always be at least one certificate per active connection.
# /%}
#
# == Parameters:
# organization_id::
Expand Down

0 comments on commit e6def63

Please sign in to comment.