Stytch Android/com.stytch.sdk.b2b.sso/SSO/SAML

SAML

interface SAML

The SAML interface provides methods for creating, updating, and deleting a SAML connection

Types

CreateParameters

data class CreateParameters @JvmOverloads constructor(val displayName: String? = null)

Data class used for wrapping the parameters for a SAML creation request

DeleteVerificationCertificateParameters

data class DeleteVerificationCertificateParameters(val connectionId: String, val certificateId: String)

Data class used for wrapping the parameters to delete a SAML verification certificate

UpdateByURLParameters

data class UpdateByURLParameters(val connectionId: String, val metadataUrl: String)

Data class used for wrapping the parameters for a SAML update by URL request

UpdateParameters

data class UpdateParameters @JvmOverloads constructor(val connectionId: String, val idpEntityId: String? = null, val displayName: String? = null, val attributeMapping: Map<String, String>? = null, val idpSsoUrl: String? = null, val x509Certificate: String? = null, val samlConnectionImplicitRoleAssignment: List<ConnectionRoleAssignment>? = null, val samlGroupImplicitRoleAssignment: List<GroupRoleAssignment>? = null)

Data class used for wrapping the parameters for a SAML update request

Functions

createConnection

abstract suspend fun createConnection(parameters: SSO.SAML.CreateParameters): B2BSSOSAMLCreateConnectionResponse

abstract fun createConnection(parameters: SSO.SAML.CreateParameters, callback: (B2BSSOSAMLCreateConnectionResponse) -> Unit)

Create a new SAML Connection.

createConnectionCompletable

abstract fun createConnectionCompletable(parameters: SSO.SAML.CreateParameters): CompletableFuture<B2BSSOSAMLCreateConnectionResponse>

Create a new SAML Connection.

deleteVerificationCertificate

abstract suspend fun deleteVerificationCertificate(parameters: SSO.SAML.DeleteVerificationCertificateParameters): B2BSSOSAMLDeleteVerificationCertificateResponse

abstract fun deleteVerificationCertificate(parameters: SSO.SAML.DeleteVerificationCertificateParameters, callback: (B2BSSOSAMLDeleteVerificationCertificateResponse) -> Unit)

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.

deleteVerificationCertificateCompletable

abstract fun deleteVerificationCertificateCompletable(parameters: SSO.SAML.DeleteVerificationCertificateParameters): CompletableFuture<B2BSSOSAMLDeleteVerificationCertificateResponse>

updateConnection

abstract suspend fun updateConnection(parameters: SSO.SAML.UpdateParameters): B2BSSOSAMLUpdateConnectionResponse

abstract fun updateConnection(parameters: SSO.SAML.UpdateParameters, callback: (B2BSSOSAMLUpdateConnectionResponse) -> Unit)

Update a SAML Connection.

updateConnectionByUrl

abstract suspend fun updateConnectionByUrl(parameters: SSO.SAML.UpdateByURLParameters): B2BSSOSAMLUpdateConnectionByURLResponse

abstract fun updateConnectionByUrl(parameters: SSO.SAML.UpdateByURLParameters, callback: (B2BSSOSAMLUpdateConnectionByURLResponse) -> Unit)

Update a SAML Connection by URL.

updateConnectionByUrlCompletable

abstract fun updateConnectionByUrlCompletable(parameters: SSO.SAML.UpdateByURLParameters): CompletableFuture<B2BSSOSAMLUpdateConnectionByURLResponse>

Update a SAML Connection by URL.

updateConnectionCompletable

abstract fun updateConnectionCompletable(parameters: SSO.SAML.UpdateParameters): CompletableFuture<B2BSSOSAMLUpdateConnectionResponse>

Update a SAML Connection.