Stytch Android/com.stytch.sdk.b2b

Package-level declarations

Stytch's B2B SDK makes it simple to seamlessly onboard, authenticate, and engage users. This SDK provides the easiest way for you to use Stytch on Android. With just a few lines of code, you can easily authenticate your users and get back to focusing on the core of your product.

Supported Authentication Products

  • magicLinks

    • Send/authenticate magic links via Email

  • sessions

    • Authenticate/refresh an existing session

    • Revoke a session (Sign out)

  • member

    • Get or fetch the current user object (sync/cached or async options available)

  • organization

    • Get or fetch the current user's organization

Using the B2B SDK

The StytchB2BClient object is your entrypoint to the Stytch B2B SDK and is how you interact with all of our supported authentication products.

Each endpoint is explained in their respective READMEs and inline-documentation, but there are a few special methods on the StytchB2BClient object to document here.

Configuration

As mentioned in the /README.md, before making any Stytch authentication requests, you must configure the StytchB2BClient:

StytchB2BClient.configure(context, publicToken)
Content copied to clipboard

This configures the API for authenticating requests and the encrypted storage helper for persisting session data across app launches.

Handling Deeplinks

StytchB2BClient.handle() is the method you call for parsing out and authenticating deeplinks that your application receives. The currently supported deeplink types are: B2B Email Magic Links. This method returns a ../common/DeeplinkHandledStatus.kt class which details the result of the authentication call.

For B2B Email Magic Links, it will return a Handled class containing either the authenticated response or error.

Any other link types passed to this method will return a NotHandled class.

Types

Link copied to clipboard
typealias B2BSearchMemberResponse = StytchResult<B2BSearchMemberResponseData>

Type alias for StytchResult used for Search Member responses

Link copied to clipboard
typealias B2BSearchOrganizationResponse = StytchResult<B2BSearchOrganizationResponseData>

Type alias for StytchResult used for Search Organization responses

Link copied to clipboard
typealias B2BSSODeleteConnectionResponse = StytchResult<B2BSSODeleteConnectionResponseData>

Type alias for StytchResult used for SSO Connection Deletion responses

Link copied to clipboard
typealias B2BSSOGetConnectionsResponse = StytchResult<B2BSSOGetConnectionsResponseData>

Type alias for StytchResult used for SSO Get Connection responses

Link copied to clipboard
typealias B2BSSOOIDCCreateConnectionResponse = StytchResult<B2BSSOOIDCCreateConnectionResponseData>

Type alias for StytchResult used for SSO OIDC Connection Create responses

Link copied to clipboard
typealias B2BSSOOIDCUpdateConnectionResponse = StytchResult<B2BSSOOIDCUpdateConnectionResponseData>

Type alias for StytchResult used for SSO OIDC Connection Update responses

Link copied to clipboard
typealias B2BSSOSAMLCreateConnectionResponse = StytchResult<B2BSSOSAMLCreateConnectionResponseData>

Type alias for StytchResult used for SSO SAML Connection Creation responses

typealias B2BSSOSAMLDeleteVerificationCertificateResponse = StytchResult<B2BSSOSAMLDeleteVerificationCertificateResponseData>

Type alias for StytchResult used for SSO SAML Verification Certificate Deletion responses

Link copied to clipboard
typealias B2BSSOSAMLUpdateConnectionByURLResponse = StytchResult<B2BSSOSAMLUpdateConnectionByURLResponseData>

Type alias for StytchResult used for SSO SAML Connection Update by URL responses

Link copied to clipboard
typealias B2BSSOSAMLUpdateConnectionResponse = StytchResult<B2BSSOSAMLUpdateConnectionResponseData>

Type alias for StytchResult used for SSO SAML Connection Update responses

Link copied to clipboard
enum B2BTokenType : Enum<B2BTokenType> , TokenType

An enum representing the supported (B2B) token types that we can extract from a deeplink

Link copied to clipboard
typealias BasicResponse = StytchResult<BasicData>

Type alias for StytchResult used for non-specific responses

Link copied to clipboard
typealias CreateMemberResponse = StytchResult<MemberResponseCommonData>

Type alias for StytchResult used for Create Organization Member responses

Link copied to clipboard
typealias DeleteMemberAuthenticationFactorResponse = StytchResult<MemberDeleteAuthenticationFactorData>

Type alias for StytchResult used for MemberDeleteAuthenticationFactor responses

Link copied to clipboard
typealias DeleteMemberResponse = StytchResult<OrganizationMemberDeleteResponseData>

Type alias for StytchResult used for Organization Delete Member responses

typealias DeleteOrganizationMemberAuthenticationFactorResponse = StytchResult<MemberResponseCommonData>

Type alias for StytchResult used for Delete Organization Member authentication factor responses

Link copied to clipboard
typealias DeleteOrganizationResponse = StytchResult<OrganizationDeleteResponseData>

Type alias for StytchResult used for Organization Delete responses

Link copied to clipboard
typealias DiscoverOrganizationsResponse = StytchResult<DiscoveredOrganizationsResponseData>

Type alias for StytchResult used for discovery.organizations() responses

Link copied to clipboard
typealias DiscoveryEMLAuthResponse = StytchResult<DiscoveryAuthenticateResponseData>

Type alias for StytchResult used for magicLinks.discovery.authenticate() responses

Link copied to clipboard
typealias EmailResetResponse = StytchResult<EmailResetResponseData>

Type alias for StytchResult used for passwords.resetByEmail() responses

Link copied to clipboard
typealias EMLAuthenticateResponse = StytchResult<B2BEMLAuthenticateData>

Type alias for StytchResult used for Email Magic Link Authenticate responses

Link copied to clipboard
typealias IntermediateSessionExchangeResponse = StytchResult<IntermediateSessionExchangeResponseData>

Type alias for StytchResult used for discovery.exchangeSession() responses

Link copied to clipboard
typealias MemberResponse = StytchResult<MemberResponseData>

Type alias for StytchResult used for member.get() responses

Link copied to clipboard
typealias MemberSearchResponse = StytchResult<MemberSearchResponseData>

Type alias for StytchResult used for Member Search responses

Link copied to clipboard
typealias OAuthAuthenticateResponse = StytchResult<OAuthAuthenticateResponseData>

Type alias for StytchResult used for OAuth Authentication responses

Link copied to clipboard
typealias OAuthDiscoveryAuthenticateResponse = StytchResult<DiscoveryAuthenticateResponseData>

Type alias for StytchResult used for Discovery Authentication responses

Link copied to clipboard
typealias OrganizationCreateResponse = StytchResult<OrganizationCreateResponseData>

Type alias for StytchResult used for discovery.create() responses

Link copied to clipboard
typealias OrganizationResponse = StytchResult<OrganizationResponseData>

Type alias for StytchResult used for organization.get() responses

Link copied to clipboard
typealias PasswordResetByExistingPasswordResponse = StytchResult<PasswordResetByExistingPasswordResponseData>

Type alias for StytchResult used for Password Reset By Existing Password responses

Link copied to clipboard
typealias PasswordsAuthenticateResponse = StytchResult<PasswordsAuthenticateResponseData>

Type alias for StytchResult used for Passwords Authenticate responses

Link copied to clipboard
typealias PasswordStrengthCheckResponse = StytchResult<StrengthCheckResponseData>

Type alias for StytchResult used for passwords.strengthCheck() responses

Link copied to clipboard
typealias ReactivateMemberResponse = StytchResult<MemberResponseCommonData>

Type alias for StytchResult used for Reactivate Organization Member responses

Link copied to clipboard
typealias RecoveryCodesGetResponse = StytchResult<RecoveryCodeGetResponseData>

Type alias for StytchResult used for Recovery Code Get responses

Link copied to clipboard
typealias RecoveryCodesRecoverResponse = StytchResult<RecoveryCodeRecoverResponseData>

Type alias for StytchResult used for Recovery Code Recover responses

Link copied to clipboard
typealias RecoveryCodesRotateResponse = StytchResult<RecoveryCodeRotateResponseData>

Type alias for StytchResult used for Recovery Code Rotate responses

Link copied to clipboard
typealias SCIMCreateConnectionResponse = StytchResult<B2BSCIMCreateConnectionResponseData>

Type alias for StytchResult used for SCIM Create Connection responses

Link copied to clipboard
typealias SCIMDeleteConnectionResponse = StytchResult<B2BSCIMDeleteConnectionResponseData>

Type alias for StytchResult used for SCIM Delete Connection responses

Link copied to clipboard
typealias SCIMGetConnectionGroupsResponse = StytchResult<B2BSCIMGetConnectionGroupsResponseData>

Type alias for StytchResult used for SCIM Get Connection Groups responses

Link copied to clipboard
typealias SCIMGetConnectionResponse = StytchResult<B2BSCIMGetConnectionResponseData>

Type alias for StytchResult used for SCIM Get Connection responses

Link copied to clipboard
typealias SCIMRotateCancelResponse = StytchResult<B2BSCIMRotateCancelResponseData>

Type alias for StytchResult used for SCIM Rotate Cancel responses

Link copied to clipboard
typealias SCIMRotateCompleteResponse = StytchResult<B2BSCIMRotateCompleteResponseData>

Type alias for StytchResult used for SCIM Rotate Complete responses

Link copied to clipboard
typealias SCIMRotateStartResponse = StytchResult<B2BSCIMRotateStartResponseData>

Type alias for StytchResult used for SCIM Rotate Start responses

Link copied to clipboard
typealias SCIMUpdateConnectionResponse = StytchResult<B2BSCIMUpdateConnectionResponseData>

Type alias for StytchResult used for SCIM Update Connection responses

Link copied to clipboard
typealias SessionExchangeResponse = StytchResult<SessionExchangeResponseData>

Type alias for StytchResult used for session.exchange() responses

Link copied to clipboard
typealias SessionResetResponse = StytchResult<SessionResetResponseData>

Type alias for StytchResult used for passwords.resetBySession() responses

Link copied to clipboard
typealias SessionsAuthenticateResponse = StytchResult<SessionsAuthenticateResponseData>

Type alias for StytchResult used for Sessions Authenticate responses

Link copied to clipboard
typealias SMSAuthenticateResponse = StytchResult<SMSAuthenticateResponseData>

Type alias for StytchResult used for SMS OTP Authenticate responses

Link copied to clipboard
typealias SSOAuthenticateResponse = StytchResult<SSOAuthenticateResponseData>

Type alias for StytchResult used for sso.authenticate() responses

Link copied to clipboard
object StytchB2BClient

The StytchB2BClient object is your entrypoint to the Stytch B2B SDK and is how you interact with all of our supported authentication products.

Link copied to clipboard
typealias TOTPAuthenticateResponse = StytchResult<TOTPAuthenticateResponseData>

Type alias for StytchResult used for TOTP Authenticate responses

Link copied to clipboard
typealias TOTPCreateResponse = StytchResult<TOTPCreateResponseData>

Type alias for StytchResult used for TOTP Create responses

Link copied to clipboard
typealias UpdateMemberResponse = StytchResult<UpdateMemberResponseData>

Type alias for StytchResult used for UpdateMember responses

Link copied to clipboard
typealias UpdateOrganizationMemberResponse = StytchResult<MemberResponseCommonData>

Type alias for StytchResult used for Update Organization Member responses

Link copied to clipboard
typealias UpdateOrganizationResponse = StytchResult<OrganizationUpdateResponseData>

Type alias for StytchResult used for Organization Update responses