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

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

Constructors

UpdateParameters

@JvmOverloads

constructor(connectionId: String, idpEntityId: String? = null, displayName: String? = null, attributeMapping: Map<String, String>? = null, idpSsoUrl: String? = null, x509Certificate: String? = null, samlConnectionImplicitRoleAssignment: List<ConnectionRoleAssignment>? = null, samlGroupImplicitRoleAssignment: List<GroupRoleAssignment>? = null)

Properties

attributeMapping

val attributeMapping: Map<String, String>? = null

An object that represents the attributes used to identify a Member. This object will map the IdP-defined User attributes to Stytch-specific values. Required attributes: email and one of full_name or first_name and last_name

connectionId

val connectionId: String

Globally unique UUID that identifies a specific SAML Connection.

displayName

val displayName: String? = null

A human-readable display name for the connection.

idpEntityId

val idpEntityId: String? = null

A globally unique name for the IdP. This will be provided by the IdP.

idpSsoUrl

val idpSsoUrl: String? = null

The URL for which assertions for login requests will be sent. This will be provided by the IdP.

samlConnectionImplicitRoleAssignment

val samlConnectionImplicitRoleAssignment: List<ConnectionRoleAssignment>? = null

An array of implicit role assignments granted to members in this organization who log in with this SAML connection.

samlGroupImplicitRoleAssignment

val samlGroupImplicitRoleAssignment: List<GroupRoleAssignment>? = null

An array of implicit role assignments granted to members in this organization who log in with this SAML connection and belong to the specified group. Before adding any group implicit role assignments, you must add a "groups" key to your SAML connection's attribute_mapping. Make sure that your IdP is configured to correctly send the group information.

x509Certificate

val x509Certificate: String? = null

A certificate that Stytch will use to verify the sign-in assertion sent by the IdP, in {@link https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail PEM} format.