B2BSCIMClient

interface B2BSCIMClient

SCIM (System for Cross-domain Identity Management) provisioning methods.

Functions

Link copied to clipboard
abstract suspend fun createConnection(request: IB2BSCIMCreateConnectionParameters): B2BSCIMCreateConnectionResponse

Creates a new SCIM connection for the organization. Calls the POST /sdk/v1/b2b/scim endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun deleteConnection(connectionId: String): B2BSCIMDeleteConnectionResponse

Deletes the specified SCIM connection. Calls the DELETE /sdk/v1/b2b/scim/{connection_id} endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun getConnection(): B2BGetSCIMConnectionResponse

Retrieves the organization's SCIM connection. Calls the GET /sdk/v1/b2b/scim endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun getConnectionGroups(request: IB2BGetSCIMConnectionGroupsParameters): B2BGetSCIMConnectionGroupsResponse

Retrieves the groups associated with the organization's SCIM connection. Calls the POST /sdk/v1/b2b/scim/groups endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun rotateTokenCancel(request: ISCIMRotateTokenCancelParameters): SCIMRotateTokenCancelResponse

Cancels an in-progress SCIM bearer token rotation, keeping the existing token active. Calls the POST /sdk/v1/b2b/scim/rotate/cancel endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun rotateTokenComplete(request: ISCIMRotateTokenCompleteParameters): SCIMRotateTokenCompleteResponse

Completes a SCIM bearer token rotation, activating the new token and invalidating the old one. Must be called after rotateTokenStart. Calls the POST /sdk/v1/b2b/scim/rotate/complete endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun rotateTokenStart(request: ISCIMRotateTokenStartParameters): SCIMRotateTokenStartResponse

Initiates a SCIM bearer token rotation for the specified connection. The new token is generated in a pending state; call rotateTokenComplete to activate it. Calls the POST /sdk/v1/b2b/scim/rotate/start endpoint. Requires an active session.

Link copied to clipboard
abstract suspend fun updateConnection(connectionId: String, request: IB2BSCIMUpdateConnectionParameters): B2BSCIMUpdateConnectionResponse

Updates settings on the specified SCIM connection. Calls the PUT /sdk/v1/b2b/scim/{connection_id} endpoint. Requires an active session.