Mapping rule options

Mapping rules can contain options that target the fields of an access token.

A field represents an aspect of a cross-domain access token, such as the primary UID and primary user SID from a user that you select. You can see some of the fields in the OneFS web administration interface. User in the web administration interface is the same as username. You can also see fields in an access token by running the command isi auth mapping token.

When you create a rule, you can add an option to manipulate how OneFS combines aspects of two identities into a single token. For example, an option can force OneFS to append the supplement groups to a token.

A token includes the following fields that you can manipulate with user mapping rules:

Options control how a rule combines identity information in a token. The break option is the exception: It stops OneFS from processing additional rules.

Although several options can apply to a rule, not all options apply to all operators. The following table describes the effect of each option and the operators that they work with.

Option
Operator
Description
user
insert, append
Copies the primary UID and primary user SID, if they exist, to the token.
groups
insert, append
Copies the primary GID and primary group SID, if they exist, to the token.
groups
insert, append
Copies all the additional identifiers to the token. The additional identifiers exclude the primary UID, the primary GID, the primary user SID, and the primary group SID.
default_user
all operators except remove groups
If the mapping service fails to find the second user in a rule, the service tries to find the username of the default user. The name of the default user cannot include wildcards. When you set the option for the default user in a rule with the command-line interface, you must set it with an underscore: default_user.
break
all operators
Stops the mapping service from applying rules that follow the insertion point of the break option. The mapping service generates the final token at the point of the break.