ROI iAM

Appearance

Attributes ​

Overview ​

The Attribute section of ROI iAM provides an overview of all predefined attribute schemas, and gives the tools to create, modify or delete them.

Attributes are associated with a schema. Under this section, the user can display all the attributes associated with a schema, both custom and standard. Some attributes are "read-only", while others are configurable. The attributes are grouped together to have meaningful structures. Users can review, amend, or create their own attributes under a specific schema, based on specific requirements.

Access ​

To learn more about the necessary access and prerequisite requirements for this section, please review the following documentation: Security

List view ​

The list view displays all attribute structures in the current version or revision.

Attributes

Creating an attribute schema ​

To create a new attribute schema:

  1. Press the Create button, located next to the search field.
  2. Choose whether the identifier should be automatically generated or manually defined. Using the toggle will change the create dialog based on the selection.

    INFO

    When using an automatically generated identifier, it will always be prefixed with urn:roiable:roiam:params:scim:schemas: and include the SCIM type, version, and name. An identifier should start with urn: and contain :scim:. It can contain colon, dots, digits (in the version only), and letters. The identifier can be up to 250 characters long.

  3. Enter a Name. - This field is mandatory. The name should start with a capital letter and should only contain letters, colons, or dots.
  4. Enter a SCIM Type. - This field is mandatory. Select the SCIM Type from the dropdown (Core or Extension).
  5. Enter a Version. - This field is mandatory. It can only contain number and dots.
  6. Input a Description. - This field is mandatory. The description can be up to 512 characters long.

Details view ​

The details view provides an overview or the attribute schema description and attributes. These can be edited when the schema is not read-only and when on a non-active version or revision.

The controls for the details view are located in the upper right corner. Left to right, we have the following buttons:

  • Edit - Enters edit mode, allowing you to modify the schema properties and attributes.
  • Delete - Deletes the schema.
  • Export - Exports the schema.

Attributes

Edit mode ​

Metadata ​

  • Description - Can be modified by entering text in the description field. This field cannot be left empty.

Attributes ​

Attributes can be added, modified, and deleted.

Each attribute has the following properties:

  • Name
  • Key - Indicates whether this is a key attribute.
  • Type - Available types include: string, boolean, decimal, integer, dateTime, reference, binary, and complex.
  • Default Value
  • Required - Indicates whether the attribute is mandatory.
  • Multi-Valued - When enabled, the attribute can hold multiple values.
  • Description

To create a new Attribute ​

  1. Click Add to open the creation dialog.
  2. Enter a Name – This field is mandatory. Attribute names are case-sensitive and must match the original attribute name.
  3. Select a Parent attribute (if applicable). Only attributes of type complex can serve as parent attributes.
  4. Select the Type – This field is mandatory.
  5. When all required fields are completed, click Add.

After clicking Add, the new attribute appears in the Attribute Definitions table.

To edit an attribute ​

  1. Click Edit next to the attribute.
  2. Apply the desired changes.
  3. Click OK to confirm.

    INFO

    An attribute name can be changed immediately after creation and before saving the schema using the Save button.

    TIP

    To delete an attribute, click Delete next to the attribute.

All changes are saved only after clicking the Save button in the upper-right corner of the details view. Closing the details view or pressing Cancel exits edit mode and discards any unsaved changes.

See also ​