Stytch Android/com.stytch.sdk.b2b.scim/SCIM

SCIM

interface SCIM

The SCIM interface provides methods for creating, getting, updating, deleting, and rotating SCIM connections

Types

Link copied to clipboard
data class CreateConnectionParameters(val displayName: String? = null, val identityProvider: String? = null)

A data class wrapping the parameters needed to create a SCIM connection

Link copied to clipboard
data class GetConnectionGroupsParameters(val limit: Int? = null, val cursor: String? = null)

A data class wrapping the parameters needed to get connection groups

Link copied to clipboard
data class UpdateConnectionParameters(val connectionId: String, val displayName: String? = null, val identityProvider: String? = null, val scimGroupImplicitRoleAssignments: List<SCIMGroupImplicitRoleAssignment>? = null)

A data class wrapping the parameters needed to update a SCIM connection

Functions

Link copied to clipboard
abstract suspend fun createConnection(parameters: SCIM.CreateConnectionParameters): SCIMCreateConnectionResponse
abstract fun createConnection(parameters: SCIM.CreateConnectionParameters, callback: (SCIMCreateConnectionResponse) -> Unit)

Creates a new SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/create-scim-connection create-connection} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun createConnectionCompletable(parameters: SCIM.CreateConnectionParameters): CompletableFuture<SCIMCreateConnectionResponse>

Creates a new SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/create-scim-connection create-connection} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun deleteConnection(connectionId: String): SCIMDeleteConnectionResponse
abstract fun deleteConnection(connectionId: String, callback: (SCIMDeleteConnectionResponse) -> Unit)

Deletes an existing SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/delete-scim-connection delete-connection} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun deleteConnectionCompletable(connectionId: String): CompletableFuture<SCIMDeleteConnectionResponse>

Deletes an existing SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/delete-scim-connection delete-connection} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun getConnection(): SCIMGetConnectionResponse
abstract fun getConnection(callback: (SCIMGetConnectionResponse) -> Unit)

Gets the SCIM connection for an organization. This method wraps the {@link https://stytch.com/docs/b2b/api/get-scim-connection get-connection} endpoint. The caller must have permission to view SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun getConnectionCompletable(): CompletableFuture<SCIMGetConnectionResponse>

Gets the SCIM connection for an organization. This method wraps the {@link https://stytch.com/docs/b2b/api/get-scim-connection get-connection} endpoint. The caller must have permission to view SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun getConnectionGroups(parameters: SCIM.GetConnectionGroupsParameters): SCIMGetConnectionGroupsResponse
abstract fun getConnectionGroups(parameters: SCIM.GetConnectionGroupsParameters, callback: (SCIMGetConnectionGroupsResponse) -> Unit)

Gets all groups associated with an organization's SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/get-scim-connection-groups get-connection-groups} endpoint. The caller must have permission to view SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun getConnectionGroupsCompletable(parameters: SCIM.GetConnectionGroupsParameters): CompletableFuture<SCIMGetConnectionGroupsResponse>

Gets all groups associated with an organization's SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/get-scim-connection-groups get-connection-groups} endpoint. The caller must have permission to view SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun rotateCancel(connectionId: String): SCIMRotateCancelResponse
abstract fun rotateCancel(connectionId: String, callback: (SCIMRotateCancelResponse) -> Unit)

Cancels the SCIM bearer token rotate, removing the new bearer token issued. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-cancel cancel-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun rotateCancelCompletable(connectionId: String): CompletableFuture<SCIMRotateCancelResponse>

Cancels the SCIM bearer token rotate, removing the new bearer token issued. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-cancel cancel-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun rotateComplete(connectionId: String): SCIMRotateCompleteResponse
abstract fun rotateComplete(connectionId: String, callback: (SCIMRotateCompleteResponse) -> Unit)

Completes the SCIM bearer token rotate, removing the old bearer token from operation. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-complete complete-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun rotateCompleteCompletable(connectionId: String): CompletableFuture<SCIMRotateCompleteResponse>

Completes the SCIM bearer token rotate, removing the old bearer token from operation. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-complete complete-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun rotateStart(connectionId: String): SCIMRotateStartResponse
abstract fun rotateStart(connectionId: String, callback: (SCIMRotateStartResponse) -> Unit)

Starts the SCIM bearer token rotation process. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-start start-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun rotateStartCompletable(connectionId: String): CompletableFuture<SCIMRotateStartResponse>

Starts the SCIM bearer token rotation process. This method wraps the {@link https://stytch.com/docs/b2b/api/scim-rotate-token-start start-rotation} endpoint. The caller must have permission to modify SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract suspend fun updateConnection(parameters: SCIM.UpdateConnectionParameters): SCIMUpdateConnectionResponse
abstract fun updateConnection(parameters: SCIM.UpdateConnectionParameters, callback: (SCIMUpdateConnectionResponse) -> Unit)

Updates an existing SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/update-scim-connection update-connection} endpoint. If attempting to modify the scim_group_implicit_role_assignments the caller must have the update.settings.implicit-roles permission on the stytch.organization resource. For all other fields, the caller must have the update permission on the stytch.scim resource. SCIM via the project's RBAC policy & their role assignments.

Link copied to clipboard
abstract fun updateConnectionCompletable(parameters: SCIM.UpdateConnectionParameters): CompletableFuture<SCIMUpdateConnectionResponse>

Updates an existing SCIM connection. This method wraps the {@link https://stytch.com/docs/b2b/api/update-scim-connection update-connection} endpoint. If attempting to modify the scim_group_implicit_role_assignments the caller must have the update.settings.implicit-roles permission on the stytch.organization resource. For all other fields, the caller must have the update permission on the stytch.scim resource. SCIM via the project's RBAC policy & their role assignments.