ROI iAM

Appearance

Entity Viewer Main View ​

Overview ​

The Main page of the entity viewer contains the entry point for the browser.

Refer to the following screenshot as an exampleEntity Viewer

INFO

With the current version of ROI iAM, the Entity Viewer supports only browsing mode. Editing an entity via is currently not supported.

TIP

All queries are based on the data and Model Entities in the current Active version of ROI iAM. Support for queries in revisions will be planned in upcoming releases.

Entity Selection ​

Users can select the desired Entity frop the dropdown on the main view. The list is populated with all the Model Entities defined in the current Active version. The default selected Entity upon navigation is Identity.

Refer to the following screenshot as an exampleEntity Viewer Dropdown Selection

After selecting Model entity, two schemas are being used for population of the table columns and shown attributes. The ModelEntity Entity schema created for each Model entity in ROI iAM and the core schema of the Model Entity i.e. Identity.

From the ModelEntity Entity schema

text
urn:roiable:roiam:params:scim:schemas:extension:2.0:ModelEntity
  • uniqueIdentifier
  • description
  • validFrom
  • validTo

From the core schema of the selected Model Entity, all attributes marked as required.

In our example Identity it has only the userName attribute.

text
urn:ietf:params:scim:schemas:core:2.0:User
  • userName

Refer to the following screenshot as an example:

Entity Viewer Dropdown Selection

The search functionality utilizes SCIM syntax, since under the hood the Entity Viewer browser uses the ROI iAM SCIM API.

Entity Viewer Search

All queries internally are peformed with the $filter= clause labeled as Expert Search.

INFO

With the current version of ROI iAM, the Entity Viewer supports only $filter= clause by default. ROI iAM Basic search - implementing $textFilter= clause will be introduced in the upcoming releases.

Example:

text
emails.value co '@roiable.com'

Will return all Identity entities which have value in the emails containing the '@roiable.com' value.

Example:

text
urn:roiable:roiam:params:scim:schemas:extension:2.0:ModelEntity:uniqueIdentifier eq IDENTITY:john.doe@roiable.com.jd

Will return the Entity with uniqueIdentifier attribute from the urn:roiable:roiam:params:scim:schemas:extension:2.0:ModelEntity schema equal to IDENTITY:john.doe@roiable.com.jd

INFO

All result pages contain 100 entities.

TIP

All attributes retrieved from the Search query entities are the attributes from the mentioned schemas in the previous section - e.g. ModelEntity and the Core Entity schema.