Red Hat 3Scale API Management is installed with a default administrator account named admin and the password can be retrieved by executing the command below.
oc get secret system-seed -o json | jq -r .data.ADMIN_PASSWORD | base64 -d
There are 2 types of users in Red Hat 3Scale API Management
- Admins: Which have full access to all functions and services, and can invite other members
- Members: Which have limited access to functions of the product (e.g. Analytics, Developer Portal).
This blog will describe the steps to add users to access the 3Scale Admin Portal and manage the access rights of the newly added user.
Prerequisites
Red Hat Integration — 3Scale Operator version 2.11 is installed into the Openshift Cluster version 4.9.*.
To install Red Hat Integration — 3Scale Operator, please refer to [1].
Install MailDev as mail server
- This MailDev is a simple way to test your project’s generated emails during development with an easy to use web interface that runs on your Openshift Cluster.
- SMTP servers need to be configured in order for Red Hat 3Scale API Management to send emails to users. This MailDev is for testing purposes only. For production, please use the SMTP server of your organization.
- Clone this git repository (https://github.com/kwkoo/maildev-openshift.git) on your local machine.
- Enter the command oc login to your openshift cluster. I have created a project named mail for installing this.
- Go to the maildev-openshift folder after cloning the git repository.
- Enter the command oc project mail to switch over to the correct project.
- Execute make deploy to deploy MailDev.
- Execute make console to deploy the web browser.
- Execute make send-email to test if the email is sent and received successfully.
Configure SMTP Server in 3Scale
- If you have not logged into your openshift cluster, use oc login to login to your cluster.
- Execute oc project <scale project> to switch over to project with 3scale installed.
- Execute the following commands to configure the MailDev as the SMTP server:
oc patch secret system-smtp -p ‘{“stringData”:{“address”:”maildev-smtp.mail.svc.cluster.local”}}’
oc patch secret system-smtp -p ‘{“stringData”:{“port”:”25”}}’
oc patch secret system-smtp -p ‘{“stringData”:{“from_address”:”user1@example.com”}}’
- Execute the following commands to redeploy the system-app and system-sidekiq pods:
oc rollout latest dc/system-app
oc rollout latest dc/system-sidekiq
- Execute the following commands to check the status of the rollout to ensure it has finished:
oc rollout status dc/system-app
oc rollout status dc/system-sidekiq
Invite new user
- Login to 3Scale Admin Portal as administrator.
- Navigate to Account Settings -> Account Settings.
- Expand Users and click on Invitations.
- Click on + Invite a New Team Member link
- Specify the email address of the new member. For testing purposes, you can use user2@example.com. For production, please use the corporate email address.
- The user will receive an email to activate the account.
- Use the link to sign in. This user will be added with a member role by default.
- The administrator needs to assign the correct rights to the new user by navigating to Users -> Listing. Click on the new user. Scroll down to the Administrative section to assign the access rights.
- Login to 3Scale Admin Portal as the new user. You will now be able to access the portal based on the rights that the administrator had granted.
Please refer to the link below.
