Okera Portal UI Basics¶
The Okera Portal UI is the browser-based interface used for:
- Viewing your account information
- Finding and understanding datasets
- Getting Started with using a dataset
- Inspecting roles and checking permissions on any dataset
For advanced administrator features, see UI for Admins
Accessing the UI¶
To access the Okera UI, browse to the URL provided by your Okera administrator.
The Okera UI is supported on the latest versions of the following browsers:
- Google Chrome
- Mozilla Firefox
- Microsoft Edge
- Apple Safari
Use the Login screen to access the UI. The Login screen is configured to provide login options depending on your cluster configuration. These options include:
Log in with credentials
Select this option to authenticate using LDAP credentials. You can then enter your username and password. See Authenticate Using Lightweight Directory Access Protocol (LDAP).
Log in with token
Select this option to authenticate with JSON Web Tokens (JWTs). You will be prompted for the access token. See Authenticate Using JSON Web Tokens.
Log in with OAuth
Select this option to authenticate with OAuth. See Authenticate Using Open Authorization (OAuth).
Log in with SAML
Select this option to authenticate with SAML. See Authenticate Using Security Access Markup Language (SAML).
Example login screen with Active Directory and Token login
A Note on SSL¶
If Okera is configured to run with SSL enabled using a self-signed certificate, the SSL certificate must be setup on your local system for the UI to be accessible to your browser. If, upon navigating to the UI, the browser warns that the site is not trusted, the SSL certificate may need to be installed.
Please note that even if you bypass your browser's certificate warning, the Okera UI will not work, with the Login screen reporting this message:
Could not contact server. Check your network connection and try again later.
If you see this message, it could mean you need to install the SSL certificate. Contact your Okera administrator.
Using the UI¶
Once you log in to the Okera UI, the Okera Home page appears. Use the menu options in the left-side menu to access other areas of the UI.
The Home page shows a quick access list of your recently starred datasets.
The Home page shows your account information:
- your Okera username
- the groups to which you belong
- the roles you have been granted
- the groups granting you those roles
- your access token, including expiry information
- your user attributes
You can use
Cmd+F (Mac) to quickly find a group or role name.
The System option on the left-side menu opens the System Information page that displays the following information about your Okera cluster:
Note: Some of this information is not available if you are using an Okera SaaS tenant.
- UI version
- Planner version
- Planner host/port
- Presto endpoint
- REST API endpoint
- JDBC URL (You can download the Okera Presto JDBC driver by selecting the Download JDBC driver link.)
- build hash
- A list of allowed data sources
- A list of available authentication methods
- Links for the Planners (Policy Engines)
- Links for the Workers (the enforcement fleet)
- the number of active users
- the number of active users in the last 30 days.
In addition, settings specific to your Okera environment are shown. These settings are mostly for Okera internal use and should not be altered. If you are using an Okera SaaS tenant, these settings are not available to you.
Okera does not recommend that you alter these settings except with the guidance of your Okera support representative. Changing the settings could result in non-optimal performance of the Okera platform.
Copying Your Access Token¶
To obtain your access token, select your username at the bottom of the navigation menu and select Copy access token.
To logout, select your username at the bottom of the navigation menu and select Logout.
Your credentials are saved in the browser until either your token expires, or you explicitly log out. Be aware of this security issue when sharing access to your computer.
View Your SaaS User Profile¶
If your Okera environment has been deployed as a SaaS tenant, you can access your SaaS user profile. To access it, select your username at the bottom of the Okera UI navigation menu and select Open user profile. A dialog opens on which you can view your Okera SaaS user profile and other options. (If you are not using an Okera SaaS tenant, you will not see this option.) For more information, see Okera SaaS User Management.
Okera SaaS User Management¶
If you are an Okera SaaS tenant account admin, you can manage the other users of the SaaS tenant. If you are an Okera SaaS tenant admin, the management dialog looks like this, with menu options on the left:
If you do not have admin privileges, only the top two menu options are available, Profile and Privacy & Security. If you are an admin, all of the Workspace options are shown. The Profile and Privacy & Security options allow all users to access their user profiles and change their passwords. The Workspace options allow admins to specify account information, add and remove users from the SaaS tenant, and set up security and single sign-on (SSO) for the tenant. For complete information about using this dialog, see this documentation.