Syntax of Identity Conversion Rules
[
{
"local": [
{
"<user> or <group> or <groups>"
}
],
"remote": [
{
"<condition>"
}
]
}
]
Parameter description:
- local: Identity information of a federated user mapped to IAM. The value of this field can contain placeholders, such as {0...n}. The attributes {0} and {1} represent the first and second remote attributes of the user information, respectively.
- remote: Information about a federated user of the IdP. This field is an expression consisting of assertion attributes and operators. The value of this field is determined by the assertion.
- condition: Conditions for the identity conversion rule to take effect. The following three types of conditions are supported:
- empty: The rule is matched to all claims containing the attribute type. This condition does not need to be specified. The condition result is the argument that is passed as input.
- any_one_of: The rule is matched only if any of the specified strings appear in the attribute type. The condition result is Boolean, not the argument that is passed as input.
- not_any_of: The rule is not matched if any of the specified strings appear in the attribute type. The condition result is Boolean, not the argument that is passed as input.
- condition: Conditions for the identity conversion rule to take effect. The following three types of conditions are supported:
The user information mapped to IAM can only contain letters, digits, spaces, hyphens (-), underscores (_), and periods (.), and cannot start with a digit.
Examples of the Empty Condition
The empty condition returns character strings to replace the local attributes {0..n}.
- In the following example, the username of a federated user will be "the value of the first remote attribute+space+the value of the second remote attribute" in IAM, that is, FirstName LastName. The group which the user belongs to is the value of the third remote attribute Group. This attribute has only one value.
[ { "local": [ { "user": { "name": "{0} {1}" } }, { "group": { "name": "{2}" } } ], "remote": [ { "type": "FirstName" }, { "type": "LastName" }, { "type": "Group" } ] } ]If the following assertion (simplified for easy understanding) is received, the username of the federated user will be John Smith and the user will only belong to the admin group.
{FirstName: John} {LastName: Smith} {Group: admin} - If a federated user will belong to multiple user groups in IAM, the identity conversion rule can be configured as follows:
In the following example, the username of a federated user will be "the value of the first remote attribute+space+the value of the second remote attribute" in IAM, that is, FirstName LastName. The groups which the user belongs to are the value of the third remote attribute Groups.
[ { "local": [ { "user": { "name": "{0} {1}" } }, { "group": { "name": "{2}" } } ], "remote": [ { "type": "FirstName" }, { "type": "LastName" }, { "type": "Groups" } ] } ]If the following assertion is received, the username of the federated user will be John Smith and the user will belong to the admin and manager groups.
{FirstName: John} {LastName: Smith} {Groups: [admin, manager]}
Examples of the "any one of" and "not any of" Conditions
Unlike the empty condition, the any one of and not any of conditions return Boolean values. These values will not be used to replace the local attributes. In the following example, only {0} will be replaced by the returned value of the first empty condition in the remote block. The value of group is fixed as admin.
- The username of the federated user in IAM is the value of the first remote attribute, that is, UserName. The federated user belongs to the admin group. This rule takes effect only for users who are members of the idp_admin group in the IdP.
[ { "local": [ { "user": { "name": "{0}" } }, { "group": { "name": "admin" } } ], "remote": [ { "type": "UserName" }, { "type": "Groups", "any_one_of": [ "idp_admin" ] } ] } ] - If a federated user will belong to multiple user groups in IAM, the identity conversion rule can be configured as follows:
The username of the federated user in IAM is the value of the first remote attribute, that is, UserName. The federated user belongs to the admin and manager groups. This rule takes effect only for users who are members of the idp_admin group in the IdP.
[ { "local": [ { "user": { "name": "{0}" } }, { "group": { "name":"admin" } }, { "group": { "name":"manager" } } ], "remote": [ { "type": "UserName" }, { "type": "Groups", "any_one_of": [ "idp_admin" ] } ] } ]- The following assertion indicates that the federated user John Smith is a member of the idp_admin group. Therefore, the user can access the cloud platform.
{UserName: John Smith} {Groups: [idp_user, idp_admin, idp_agency]} - The following assertion indicates that the federated user John Smith is not a member of the idp_admin group. Therefore, the rule does not take effect for the user and the user cannot access the cloud platform.
{UserName: John Smith} {Groups: [idp_user, idp_agency]}
- The following assertion indicates that the federated user John Smith is a member of the idp_admin group. Therefore, the user can access the cloud platform.
Example Condition Containing a Regular Expression
You can add "regex": true to a condition to calculate results using a regular expression.
[
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "admin"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "Groups",
"any_one_of": [
".*@mail.com$"
],
"regex": true
}
]
}
]
Examples of Combined Conditions
Multiple conditions can be combined using the logical operator AND.
[
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "admin"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "Groups",
"not_any_of": [
"idp_user"
]
},
{
"type": "Groups",
"not_any_of": [
"idp_agent"
]
}
]
}
]
The preceding rule is equivalent to the following:
[
{
"local": [
{
"user": {
"name": "{0}"
}
},
{
"group": {
"name": "admin"
}
}
],
"remote": [
{
"type": "UserName"
},
{
"type": "Groups",
"not_any_of": [
"idp_user",
"idp_agent"
]
}
]
}
]
Examples of Combined Rules
If multiple rules are combined, the methods for matching usernames and user groups are different.
The name of a federated user will be the username matched in the first rule that takes effect, and the user will belong to all groups matched in all rules that take effect. A federated user can log in only if at least one rule takes effect to match the username. For easy understanding, username and user group rules can be configured separately.
In the following example, the rules take effect for users in the idp_admin group. The username of each applicable federated user is UserName in IAM and the user belongs to the admin group.
[
{
"local": [
{
"user": {
"name": "{0}"
}
}
],
"remote": [
{
"type": "UserName"
}
]
},
{
"local": [
{
"group": {
"name": "admin"
}
}
],
"remote": [
{
"type": "Groups",
"any_one_of": [
"idp_admin"
]
}
]
}
]
The following assertion indicates that user John Smith is a member of the idp_admin group in the IdP and therefore meets the rules. The username of this user will be John Smith in IAM, and the user will belong to the admin group.
{UserName: John Smith}
{Groups: [idp_user, idp_admin, idp_agency]}
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
