Entity module magic link | API

The entity module magic link can be used to generate a link for the Credas portal, this will allow your users to navigate the portal in line with their permissions.

Generating your magic link

To generate an entity module magic link you need to perform a POST request to the /api/v2/ci/magic-links/entity-module endpoint with a valid request body.

You will receive a URL that is valid for 10 minutes in response.

Request body

{
  "userGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "emailAddress": "credastest@credas.com",
  "showClientLogo": true,
  "showNavigationMenu": true,
  "showUserProfileButton": true
}

emailAddress - this must correspond with a valid & properly permissioned user of the Credas portal.

showClientLogo - toggles on/off the client logo in the Credas portal.

showNavigationMenu - toggles on/off the navigation bar in the Credas portal.

showUserProfileButton- toggles on/off the user profile button in the Credas portal.

userGroupId - must correspond to the correct user group for the user. If you are not using user groups this can be removed or set as null in your request.

Audit trail

Any action taken within the Credas portal will be recorded against the user email address provided as part of the request body. 

To comply with Credas's terms & conditions you must use a user per person and not utilise shared accounts.

Example use case

Our entity module link can be useful for reseller clients to allow users to login to the Credas portal through their own website. 

Utilising this magic link can remove the need for additional development & will allow any users to benefit from the functionality available via the Credas portal.