Organizations

Overview

The Organization represents the legal entity in the Ocular framework.

The Organization module allows you to configure your SMTP to facilitate email notifications. Additionally, you can also configure authentication mechanisms, such as basic authentication and OAuth 2.0.

You can add multiple users to your organization. To learn more about users, see Users.

Create an organization

To create an organization, click Create New and enter valid values in the following fields:

Field	Description
Name	Name of the organization. Mandatory: Yes
Organization Type	Type of the organization. The following are the possible values: Product Owner — An organization providing services. Client Organization — An entity representing the end customers. Mandatory: Yes
Organization Email	Official email address of the organization. Mandatory: Yes
Company Code	Code of the company used for auditing purposes. Mandatory: No
Description	Additional details of the organization. Mandatory: No
Effective Date	Date when the organization will be available. Mandatory: Yes
Expiration Date	Date when the organization will no longer be available. Mandatory: No
Locale	Primary language used in the ogranization. Mandatory: Yes
Country	Country of origin of the organization. Mandatory: Yes
Time Zone	Primary time zone used in the organization. Mandatory: Yes

Views

Card View

The card view presents all applications in the form of cards, with the organization name and its status on the card header. The card displays the Organization Email and Organization Type. The card footer displays a duplicate icon and a delete icon.

Clicking anywhere on the card, except the duplicate and trash icons, will redirect you to view the Organization Details.

List View

The list view displays all organizations in a table format.

Column Name	Description
Name	Name of the organization.
Email	Official email address of the organization.
Organization Type	Type of the organization.
Status	Status of the application.
Actions	Displays the following icons: — Clone icon that allows you to clone the selected dataset. When clicked, a popup window is displayed asking you to provide a new Name, Organization Type, and Organization Email. All other configurations of the selected dataset are copied. — Edit icon that allows you to edit the organization details. — Delete icon that allows you to delete the selected organization.

Filter

You can filter or search the list of organizations by entering a keyword or the full name of an organization.

For example,

Sort

The following columns on the list view can be sorted:

Name
Email
Organization Type
Status

Organization Details

Organization details

The Organization Details tab shows all the information you added when creating your organization. For more information about the fields, see Create an organization.

You can also add more role groups or modify the existing ones by following the same steps in the Application Role Group.

This tab allows you to update all the fields. Additionally, you can choose to copy or delete the selected organization from this tab.

SMTP details

For the SMTP details of your organization, you can choose to use the configured default STMP or configure a different one.

When you select Use default SMTP, the configured default values are displayed, and all the SMTP details fields are disabled.

If you opt to configure a new SMTP, follow these steps:

Uncheck the Use default SMTP.
Enter valid values in the following fields:

Field	Description
Host Name	Host name of the SMTP server used to send the emails. Mandatory: Yes
Port	Port number used by the SMTP server. Mandatory: Yes
Username	Username to access the SMTP server. Mandatory: Yes
Password	Password to access the SMTP server. Mandatory: Yes
Sender Email	Email address to use for sending emails. Mandatory: Yes
Sender Name	Name of the sender to appear in the recipient's inbox. Mandatory: No
Allowed Domains	List of all the domains that are accepted to be used in the Sender Email field. Mandatory: No

Authentications

The Authentications tab lists all authentication mechanisms supported by the organization.

Add a new authentication

To add a new authentication, follow these steps:

Click Add New Authentication.
Select the type from the Authentication Type dropdown list. The following are the possible values:
- Basic Authentication
- Microsoft AZURE Authentication
- OAuth 2.0 Authentication

Microsoft Azure authentication

If you choose to add a Microsoft Azure authentication, then you need to configure the following fields:

Field	Description
Auth Code	Code or identifier used to register and reference the authentication configuration. Mandatory: Yes
Name	Display name of the authentication provider shown in the configuration list. Mandatory: Yes
Logo	Logo to be displayed on the Login page. Mandatory: Yes
Public Key	Upload the public key to use for the authentication. Mandatory: Yes

OAuth 2.0 authentication

If you choose to add an OAuth 2.0 authentication, then you need to configure the following fields:

Field	Description
Auth Code	Code or identifier used to register the authentication configuration. Mandatory: Yes
Name	Display name of the authentication provider shown in configuration list. Mandatory: Yes
Logo	Logo to be displayed on the Login page. Mandatory: Yes
Public Key	Uploaded public key used to validate tokens received from the provider. Mandatory: Yes
Authority	Base URL of the identity provider. Used to discover authorization and token endpoints. Mandatory: Yes
Client ID	Identifier of the client used to obtain an access token. Mandatory: Yes
Client Secret	Secret of the client used to obtain an access token. Mandatory: Yes except for PKCE-only setups
IDM Hosted User Flow	Indicates whether the login flow is hosted by an Identity Management service. Accepts: true or false Mandatory: No
Principal Name	Claim or field used as the primary user identifier (e.g., `email`, `preferred_username`). Mandatory: Yes
Redirect URL	URL where the identity provider sends the authorization response after login. Mandatory: Yes
Referer	Expected origin or domain allowed to initiate authentication requests. Mandatory: No (depends on provider)
Response Type	Requested OAuth/OIDC response type, such as, `code`, `token`, `id_token`). Mandatory: Yes
Tenant ID	Unique identifier of the tenant in the identity provider. Mandatory: No
Token URL	Endpoint where the application exchanges authorization codes for tokens. Mandatory: Yes
Type	Type of authentication method used. Mandatory: Yes

You can also edit an authentication by clicking , and delete an authentication by clicking next to it.

Users and Roles

The Users and Roles tab lists all the members and their roles in the organization.

If you are a framework administrator, you can view all registered users within the framework. This means that you can see all framework administrators, business administrators, and business users in the Users list.

However, if you are a business administrator, you can only view the business users. This means that your own profile will not be visible in the Users list.

This tab only displays the list of users and their roles. To perform an action on the Users list, navigate to the Users module.

Products

The Products tab lists all the products associated with your organization.

This tab only displays the list of products. To perform an action on the Products list, navigate to the Products module.

Last modified December 8, 2025: migrated fw-docs (f94aad2)