cidaas for Typo3

cidaas extension for Typo3

cidaas provides an extension which is deployed in the Typo3 marketplace, that can be configured and used by Typo3 users.

In this section, you will find steps to add cidaas extension for Typo3 to your Typo3 website.

If you are in this section, we assume you are already using Typo3, and would like to add cidaas extension to your Typo3 website for authentication.

Overall process would be

  • Download the extension "cidaas for Typo3"
  • Include cidaas templates
  • Create login page and user page (if not present)
  • Add cidaas plugin to login page
  • Configure the extension with cidaas client id and client secret
  • Verify your Configuration

How to configure "cidaas for Typo3" extension

Here you will find the steps on how to configure cidaas extension to your Typo3 website, so that your website can use cidaas login functionalities and authentication methods for user management.

We will guide you through the process — it is quite easy!

Download cidaas extension

1. Open Typo3 on your local machine.

2. Select Extensions from the side menu. Choose Get Extensions from the dropdown as shown below and search for cidaas extension. Then download cidaas for Typo3 extension.

3. Choose Installed Extensions from the dropdown. Now, you will find cidaas for Typo3 gets listed.

Include cidaas templates

In this section, you will find steps on how to edit templates and how to include the required templates of cidaas for Typo3 extension.

1. Navigate to home page of your Typo3 portal and select Templates section in the left menu and click on Edit the Whole record button.

2. Select Includes tab. Choose the templates provided by cidaas, i.e, Cidaas(cidaas) and Cidaas for felogin(cidaas) by searching it in Available items.

Now Cidaas(cidaas) and Cidaas for felogin(cidaas) templates will appear under Selected items.

Add cidaas plugin to login page

If you already have a login page, you can configure cidaas plugin to your login page. If you don't have a login page created, refer to login page creation section which is mentioned later on.

In this section, we will guide you to configure cidaas plugin as a content to your login page.

1. Select your login page to add select content. Then click on Add content button.

2. Select General Plugin option available under Plugins tab.

3. Select Cidaas Login option from Selected Plugin dropdown, available under Plugin tab and then select storage location.

If you don't have any user storage location listed here, you can create it by referring to User page creation section below.

Once done, click on Save button.

4. Now you can find cidaas plugin has been added to your login page.

Configure cidaas extension

In this section, you will find steps to configure Cidaas for Typo3 extension with your client id and client secret which is obtained from your cidaas application.

Note : If you don't have an active cidaas application, follow steps to create cidaas application section of this tutorial to create cidaas app.


1. Navigate to home page and select Extensions from the side menu. Choose Cidaas for Typo3 extension from the list and click on Configure button.

2. Enter page id of the record storage page (eg. enter id of user page, To find page id, hover the required page icon) and enter your usergroup in the Default user group field(This field can be left empty).

To know more about Default user groups refer to Role mapping section below.

3. Fill all the required details here. Get client id, client secret and scopes from cidaas and enter here. Once done, click on the Save button.

To know more about how to get cidaas clientID and client secret refer to Steps to get cidaas clientID and client secret section below.

4. Click on the Advanced tab.

5. Modify the baseurl of the endpoints with your baseurl and save it.

We are now done with the setup, and you can verify your configuration.

Verifying Configuration

Once you navigate to your Typo3 website, cidaas users can login with their credentials.

1. Run your Typo3 application.

2. Designed home page with Login button will appear. Click on that Login button.

3. Now you will be redirected to the cidaas login page. Here you can use any of the configured authentication method of cidaas to login.

4. After successful login, if you navigate to your Typo3 dashboard and select List menu. Under Users page, you'll find Website user section, which contains the details of logged in user.

Additional Info

In this section, we will guide you on few more topics include,

  • Registration fields mapping
  • Role mapping
  • Logout

Registration fields mapping

In this section, you will find steps on how to map the preferred typo3 fields to OIDC fields and to overwrite the default mapping.

1. Navigate to your Typo3 dashboard and select Templates from side menu. Select the root page of your website and click on edit button corresponding to Setup option.

2. Enter the following typoscript in the setup fields section to customize the registration fields as per your requirement.

You can modify the key-value pair under plugin.tx_oidc.mapping { fe_users { } } headers.

Here Key defines your field in Typo3 and Value defines your OIDC field which has to be enclosed in <>

Role mapping

In this section, you will find steps to create a usergroup and then mapping it to the OIDC roles to get information about the roles of user who logged in.

1. Navigate to your Typo3 dashboard and select List from side menu. Under Users page, click on the create record button as shown below,

2. Select Website Usergroup

3. Enter suitable name for usergroup.

4. Select Extended tab, select record type as shown below,

5. Enter the pattern for roles which you want to assoicate with your user group.

Pattern example : *user*,*admin*,*subscriber*. Preferably enclose the role with asterisk(*)

Now, when the user who has the role 'User' gets logs in then that user's usergroup will be assigned as 'Cidaas Users'.

Logout

In this section, we'll guide you to create logout option in the menu items which logs out the user. You also needs to restrict access to the usergroup so that the logout option will appear only when the user logs in.

1. Navigate to your Typo3 dashboard and select Page from side menu. Then right click on your root page and select More options from the menu and then select Create new wizard from the sub menu.

2. Select the position where the wizard needs to be created.

3. Choose Link to External URL from Page Type dropdown.

4. Give title for your wizard.(eg. Logout) and then enter the following url in the URL field, yourdomainname.com/index.php?logintype=logout

Note : Replace yourdomainname.com with your domain


6. Choose Access tab and then under Available items, select a usergroup (which you configured for role mapping) to restrict access. Then click on Save button.

7. Once you login successfully, you will find Logout menu in your Typo3 website.



Steps to create login page

1. Navigate to root page of your typo3 project and Right click on root page, then select More options from the menu, and then select Create new wizard option from the submenu.

2. Select the position where the page needs to be created.

3. Give a suitable title and click on save button.

Steps to create users page

Following these steps helps to create user storage location in your Typo3 account.

1. Navigate to root page of your typo3 project and Right click on root page, then select More options from the menu, and then select Create new wizard option from the submenu.

2. Select the position where the page needs to be created.

3. Select page Type as Folder, enter title as Users and click on save.

4. Now click on the newly created Users folder.
Click on Add button.

5. Select Website Usergroup.

6. Enter suitable name for usergroup and click on save button.

Steps to create cidaas app

In order to get client ID and Client Secret, you need to cretae an "App" in cidaas. This section provides steps to create "App" using cidaas administration interface, which is available after you sign up with cidaas.

1. Navigate to cidaas Administrator dashboard -> Apps -> App Settings.

2. Click on Create New App button.

3. Enter app name and then select App type as per your requirement.

4. Under App Settings, select 'email', 'openid', 'profile' as Scopes.

5. Fill out all required information and click on Save button.

Steps to get cidaas clientID and client secret

Once you created an app in cidaas, unique client id and client secret will be generated for your application.

To get those details, follow the below steps,

1. In the edit mode of your cidaas application, you can see the generated client id and client secret. To enter edit mode, Navigate to cidaas Admin dashboard -> Apps -> App Settings -> Click on the edit icon corresponding to your application.

2. You can get the client id and client secret under App Settings.

Make note of this client id and client secret.




results matching ""

    No results matching ""