Manage custom user properties

Custom properties can be set for a user; these are known as user properties. These properties can be used to provide user-specific details (such as additional passwords) to the operating system or database engine.

As an administrator, to set user properties, you must:

Have the profile.mgr scope (permission) from the Profile service.
Have the Role.Admin scope (permission) from the Authorization service.

Tip: At installation of the GIP, these two scopes are set for all members of the Administrator group; however, you should verify that the permissions remain set, as the Aministrator group can be altered after installation.

To access a custom property as a dedicated user, you must have the profile scope (permission) from the Profile service. In other words, if the profile scope is set for a user, the properties set by an administrator for that user will be returned by the profile service when that user starts a Genero application. The access to the properties is read only.

How applications access custom properties

User properties can be retrieved by any Genero application protected by the Genero Identity Provider (GIP). When a user starts a Genero application protected by the GIP, that application will automatically have all user properties accessible as environment variables. The name of the environment variable is the custom property name appended to "OIDC_", all in uppercase.

For example, if you create your first user property using the default name "PROPERTY_1", an application protected by the GIP can retrieve the value using this code:

LET my_property = fgl_getenv("OIDC_PROPERTY_1")

Tip: Use this same method to retrieve standard OIDC properties, such as OIDC_FAMILY_NAME or OIDC_GIVEN_NAME. For an additional example, see Retrieve the OpenID Connect user identifier.

Add, update, and delete user properties

Complete these steps to manage user properties for a user.

Select Users > Manage Users.
Select the user name and click Modify.
Click Properties.
The User Properties page displays. All current user properties and their assigned values are listed.
Manage user properties as needed.
1. To add a new property, click Append.
  A new line is added to the end of the user property list, with a default property name provided. You can alter the property name and add a value for the property.
  
  Click OK to save your changes.
2. To use an existing property as a template for a new property, select the property and click Copy.
  A copy of the property is added to the user property X. You can alter both the property name or the property value
  
  Click OK to save your changes.
3. To modify an existing property, select the property and click Update.
  You can alter both the property name or the property value.
  
  Click OK to save your changes.
4. To delete an existing property, select the property and click Delete
  You are asked to confirm the deletion; click Yes to confirm.
5. To delete all user properties, click Delete All
  You are asked to confirm the deletion of all properties; click Yes to confirm.
When you have completed your changes to user properties, click Save.

The user properties changes are saved, and you are returned to the User page.