Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
back

Flutter Plugin 3.0.0

User registration

search
printsuggest an edit

User registration

This topic guide explains the steps required to perform user registration.

The Onegini SDK uses the OAuth 2.0 protocol to authorize the device to access protected resources. To support this protocol the SDK acts as an OAuth 2.0 client.

copy link to clipboardPrerequisites

To initialize authentication the client credentials are required. These credentials are received via Dynamic Client Registration (DCR). As an app developer, there is no need to initialize DCR as it is part of the default implementations in the SDK.

As a timestamp is used within the DCR protocol it is mandatory that the time on the device is equal to the time on the Token Server, independent of time zones. In case of a wrong time the SDK will return an error.

copy link to clipboardStart Registration

The user registration starts with enrolling a user on a device using a selected Identity Provider (IdP). The list of all possible IdPs for an app is configured in the Token Server admin panel. The TS also configures a default (primary) IdP that is used for backward compatibility.

To start the user registration you have to call the User registration method.

var registrationResponse = await Onegini.instance.userClient
    .registerUser(identityProviderId, "read")
    .catchError((error) {
        print("Registration failed: " + error.message);
    });

if (registrationResponse.userProfile.profileId != null) {
    print("Registration success!");
}

Depending on the IdP, different registration flows will be followed to register on a device. There are two distinct flows that can be done which are explained on their respective pages:

  1. Registration with browser IdP
  2. Registration with Custom IdP

After completing the flow for browser based or custom registration you will have to register a pin in order to complete the registration. Once this has succeeded te registration will be completed.

copy link to clipboardCreate Pin

As mentioned previously, once the registration flows are finished a pin needs to be created. This is communicated by the SDK to Flutter through events as described in Event handling. The app will have to listen to these Events and respond to them accordingly.

copy link to clipboardCreate Pin Events

For more information on how to handle events and which attribute information the events might contain, see Event handling. The events that occur during the creation of the pin are described below:

Event Description
OpenPinCreationEvent Fired after starting the create pin flow
ClosePinCreationEvent Fired after supplying a valid pin for the registration and the pin has been registered.
PinNotAllowedEvent Fired when a pin is given that does not conform to the set pin policy on the token server.

copy link to clipboardCreate Pin Flow

The first event that will be thrown after the registration to set a pin will be the openPinRegistration event. A user can listen to this event using the following example code:

var owEventController = Onegini.instance.userClient.owEventStreamController;

StreamSubscription<OWEvent> openPinSubscription = owEventController.stream.where((event) => event is OpenPinRegistrationEvent).listen((event) {
      __ Your logic to handle the open pin registration event
        __ For example navigate to a new screen where a user can fill in their pin
    });

Once a user decides on a pin, the pin will then need to be communicated back to the flutter SDK. This can be done through the following method:

__ Check if the pin is valid
await Onegini.instance.userClient
  .validatePinWithPolicy(pin)
  .then((value) {
    __ pin is valid
    OneginiPinRegistrationCallback()
    .acceptAuthenticationRequest(context, pin: pin)
    .catchError((error) {
      __ handle error
    });
  })
  .catchError((error) {
    __ handle error
  });

If an invalid pin is passed on to the acceptAuthenticationRequest method, an pinNotAllowedEvent event will be thrown. In case everything went properly an ClosePinRegistrationEvent event will be thrown and the registerUser function will resolve with an OWRegistrationResponse object.

copy link to clipboardChoosing an Identity Providers

With the identityProviderId paramater from registerUser, you can decide which IdP will be used during the registration process. The available providers on the Token Server can be obtained through the getIdentityProviders method. If this parameter isn’t specified or if its value is null the default identity provider set on the Token Server will be used.

On this page