Deregistration

public protocol Deregistration : HttpOperation

The object that can be used to trigger an deregistration operation.

Usage example:

client.operations.deregistration
    .username(username)
    .aaid(aaid)
    .authorizationProvider(authorizationProvider)
    .onError { error in
        ...
    }
    .onSuccess {
        ...
    }
    .execute()

  • Specifies the username that must be deregistered.

    Important

    Providing the username is required.

    Declaration

    Swift

    @discardableResult
func username(_ username: String) -> Deregistration

    Parameters

    username

    the username.

    Return Value

    the Deregistration builder.

  • Specifies the AAID of the Authenticator that must be deregistered.

    Note

    If no AAID is provided then all authenticators will be deregistered.

    Declaration

    Swift

    @discardableResult
func aaid(_ aaid: String) -> Deregistration

    Parameters

    aaid

    the AAID of the authenticator to be deregistered.

    Return Value

    the Deregistration builder.

  • Specifies the authorization provider to be used to deregister the authenticator.

    Note

    This doesn’t have to be provided on Authentication Cloud environment.

    Declaration

    Swift

    @discardableResult
func authorizationProvider(_ authorizationProvider: AuthorizationProvider) -> Deregistration

    Parameters

    authorizationProvider

    Return Value

    the Deregistration builder.

  • Specifies the block to execute if the authenticator was deleted successfully. This object will be invoked in the DispatchQueue.main thread.

    Important

    Providing the onSuccess block is required.

    Declaration

    Swift

    @discardableResult
func onSuccess(_ onSuccess: @escaping () -> ()) -> Deregistration

    Parameters

    onSuccess

    the block to execute on successful deregistration.

    Return Value

    the Deregistration builder.

  • Specifies the block to execute if the deregistration failed. This object will be invoked in the DispatchQueue.main thread.

    Important

    Providing the onError block is required.

    Declaration

    Swift

    @discardableResult
func onError(_ onError: @escaping (OperationError) -> ()) -> Deregistration

    Parameters

    onError

    the block to execute on failed deregistration, receives an OperationError.

    Return Value

    the Deregistration builder.