Package com.stytch.sdk.b2b.scim

Interface SCIM

  • All Implemented Interfaces:
    
public interface SCIM

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

    • Constructor Detail

    • Method Detail

      • createConnection

         abstract StytchResult<B2BSCIMCreateConnectionResponseData> createConnection(SCIM.CreateConnectionParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to create a SCIM connection
        Returns:

        SCIMCreateConnectionResponse

      • createConnection

         abstract Unit createConnection(SCIM.CreateConnectionParameters parameters, Function1<StytchResult<B2BSCIMCreateConnectionResponseData>, Unit> callback)

        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.

        Parameters:
        parameters - the parameters necessary to create a SCIM connection
        callback - a callback that receives a SCIMCreateConnectionResponse

      • createConnectionCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMCreateConnectionResponseData>> createConnectionCompletable(SCIM.CreateConnectionParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to create a SCIM connection
        Returns:

        SCIMCreateConnectionResponse

      • updateConnection

         abstract StytchResult<B2BSCIMUpdateConnectionResponseData> updateConnection(SCIM.UpdateConnectionParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to update a SCIM connection
        Returns:

        SCIMUpdateConnectionResponse

      • updateConnection

         abstract Unit updateConnection(SCIM.UpdateConnectionParameters parameters, Function1<StytchResult<B2BSCIMUpdateConnectionResponseData>, Unit> callback)

        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.

        Parameters:
        parameters - the parameters necessary to update a SCIM connection
        callback - a callback that receives a SCIMUpdateConnectionResponse

      • updateConnectionCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMUpdateConnectionResponseData>> updateConnectionCompletable(SCIM.UpdateConnectionParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to update a SCIM connection
        Returns:

        SCIMUpdateConnectionResponse

      • deleteConnection

         abstract StytchResult<B2BSCIMDeleteConnectionResponseData> deleteConnection(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to be deleted
        Returns:

        SCIMDeleteConnectionResponse

      • deleteConnection

         abstract Unit deleteConnection(String connectionId, Function1<StytchResult<B2BSCIMDeleteConnectionResponseData>, Unit> callback)

        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.

        Parameters:
        connectionId - the ID of the connection to be deleted
        callback - a callback that receives a SCIMDeleteConnectionResponse

      • deleteConnectionCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMDeleteConnectionResponseData>> deleteConnectionCompletable(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to be deleted
        Returns:

        SCIMDeleteConnectionResponse

      • getConnection

         abstract StytchResult<B2BSCIMGetConnectionResponseData> getConnection()

        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.

        Returns:

        SCIMGetConnectionResponse

      • getConnection

         abstract Unit getConnection(Function1<StytchResult<B2BSCIMGetConnectionResponseData>, Unit> callback)

        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.

        Parameters:
        callback - a callback that receives a SCIMGetConnectionResponse

      • getConnectionCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMGetConnectionResponseData>> getConnectionCompletable()

        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.

        Returns:

        SCIMGetConnectionResponse

      • getConnectionGroups

         abstract StytchResult<B2BSCIMGetConnectionGroupsResponseData> getConnectionGroups(SCIM.GetConnectionGroupsParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to get connection groups
        Returns:

        SCIMGetConnectionGroupsResponse

      • getConnectionGroups

         abstract Unit getConnectionGroups(SCIM.GetConnectionGroupsParameters parameters, Function1<StytchResult<B2BSCIMGetConnectionGroupsResponseData>, Unit> callback)

        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.

        Parameters:
        parameters - the parameters necessary to get connection groups
        callback - a callback that receives a SCIMGetConnectionGroupsResponse

      • getConnectionGroupsCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMGetConnectionGroupsResponseData>> getConnectionGroupsCompletable(SCIM.GetConnectionGroupsParameters parameters)

        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.

        Parameters:
        parameters - the parameters necessary to get connection groups
        Returns:

        SCIMGetConnectionGroupsResponse

      • rotateStart

         abstract StytchResult<B2BSCIMRotateStartResponseData> rotateStart(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to start the bearer token rotation process
        Returns:

        SCIMRotateStartResponse

      • rotateStart

         abstract Unit rotateStart(String connectionId, Function1<StytchResult<B2BSCIMRotateStartResponseData>, Unit> callback)

        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.

        Parameters:
        connectionId - the ID of the connection to start the bearer token rotation process
        callback - a callback that receives a SCIMRotateStartResponse

      • rotateStartCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMRotateStartResponseData>> rotateStartCompletable(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to start the bearer token rotation process
        Returns:

        SCIMRotateStartResponse

      • rotateComplete

         abstract StytchResult<B2BSCIMRotateCompleteResponseData> rotateComplete(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to complete the bearer token rotation process
        Returns:

        SCIMRotateCompleteResponse

      • rotateComplete

         abstract Unit rotateComplete(String connectionId, Function1<StytchResult<B2BSCIMRotateCompleteResponseData>, Unit> callback)

        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.

        Parameters:
        connectionId - the ID of the connection to complete the bearer token rotation process
        callback - a callback that receives a SCIMRotateCompleteResponse

      • rotateCompleteCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMRotateCompleteResponseData>> rotateCompleteCompletable(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to complete the bearer token rotation process
        Returns:

        SCIMRotateCompleteResponse

      • rotateCancel

         abstract StytchResult<B2BSCIMRotateCancelResponseData> rotateCancel(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to cancel a bearer token rotation process
        Returns:

        SCIMRotateCancelResponse

      • rotateCancel

         abstract Unit rotateCancel(String connectionId, Function1<StytchResult<B2BSCIMRotateCancelResponseData>, Unit> callback)

        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.

        Parameters:
        connectionId - the ID of the connection to cancel a bearer token rotation process
        callback - a callback that receives a SCIMRotateCancelResponse

      • rotateCancelCompletable

         abstract CompletableFuture<StytchResult<B2BSCIMRotateCancelResponseData>> rotateCancelCompletable(String connectionId)

        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.

        Parameters:
        connectionId - the ID of the connection to cancel a bearer token rotation process
        Returns:

        SCIMRotateCancelResponse