Resource URL: /platform/<<version=1>>/auth/mapping/users/rules

    Overview: This resource returns the rules for user mapping.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve the user mapping rules.

       URL: GET /platform/<<version=1>>/auth/mapping/users/rules

Query arguments:
zone=<string> The zone to which the user mapping applies.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "rules": {
          "type": "object", 
          "description": "Specifies the properties for user mapping rules.", 
          "properties": {
            "rules": {
              "minItems": 0, 
              "items": {
                "type": "object", 
                "properties": {
                  "operator": {
                    "enum": [
                      "append", 
                      "insert", 
                      "replace", 
                      "trim", 
                      "union"
                    ], 
                    "type": "string", 
                    "description": "Specifies the operator to make rules on specified users or groups."
                  }, 
                  "user2": {
                    "type": [
                      {
                        "type": "object", 
                        "properties": {
                          "domain": {
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the domain of the user that is being mapped."
                          }, 
                          "user": {
                            "required": true, 
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the name of the user that is being mapped."
                          }
                        }
                      }, 
                      {
                        "type": "null"
                      }
                    ]
                  }, 
                  "options": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies the properties for user mapping rules.", 
                        "properties": {
                          "break": {
                            "type": "boolean", 
                            "description": "If true, and the rule was applied successfully, stop processing further."
                          }, 
                          "group": {
                            "type": "boolean", 
                            "description": "If true, the primary GID and primary group SID should be copied to the existing credential."
                          }, 
                          "user": {
                            "type": "boolean", 
                            "description": "If true, the primary UID and primary user SID should be copied to the existing credential."
                          }, 
                          "groups": {
                            "type": "boolean", 
                            "description": "If true, all additional identifiers should be copied to the existing credential."
                          }, 
                          "default_user": {
                            "type": [
                              {
                                "type": "object", 
                                "properties": {
                                  "domain": {
                                    "type": [
                                      {
                                        "minLength": 0, 
                                        "type": "string", 
                                        "maxLength": 255
                                      }, 
                                      {
                                        "type": "null"
                                      }
                                    ], 
                                    "description": "Specifies the domain of the user that is being mapped."
                                  }, 
                                  "user": {
                                    "required": true, 
                                    "type": [
                                      {
                                        "minLength": 0, 
                                        "type": "string", 
                                        "maxLength": 255
                                      }, 
                                      {
                                        "type": "null"
                                      }
                                    ], 
                                    "description": "Specifies the name of the user that is being mapped."
                                  }
                                }
                              }, 
                              {
                                "type": "null"
                              }
                            ]
                          }
                        }
                      }, 
                      {
                        "type": "null"
                      }
                    ]
                  }, 
                  "user1": {
                    "required": true, 
                    "type": [
                      {
                        "type": "object", 
                        "properties": {
                          "domain": {
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the domain of the user that is being mapped."
                          }, 
                          "user": {
                            "required": true, 
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the name of the user that is being mapped."
                          }
                        }
                      }
                    ], 
                    "description": "Specifies the first user this rule apples to."
                  }
                }
              }, 
              "type": "array", 
              "description": "Specifies the list of user mapping rules.", 
              "maxItems": 4294967295
            }, 
            "parameters": {
              "type": "object", 
              "description": "Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.", 
              "properties": {
                "default_unix_user": {
                  "type": [
                    {
                      "type": "object", 
                      "properties": {
                        "domain": {
                          "type": [
                            {
                              "minLength": 0, 
                              "type": "string", 
                              "maxLength": 255
                            }, 
                            {
                              "type": "null"
                            }
                          ], 
                          "description": "Specifies the domain of the user that is being mapped."
                        }, 
                        "user": {
                          "required": true, 
                          "type": [
                            {
                              "minLength": 0, 
                              "type": "string", 
                              "maxLength": 255
                            }, 
                            {
                              "type": "null"
                            }
                          ], 
                          "description": "Specifies the name of the user that is being mapped."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the user mapping rules.

       URL: PUT /platform/<<version=1>>/auth/mapping/users/rules

Query arguments:
zone=<string> The zone to which the user mapping applies.

PUT request body schema:
{
  "type": [
    {
      "enum": [
        "@DEFAULT"
      ], 
      "type": "string"
    }, 
    {
      "type": "object", 
      "description": "Specifies the properties for user mapping rules.", 
      "properties": {
        "rules": {
          "type": [
            {
              "enum": [
                "@DEFAULT"
              ], 
              "type": "string"
            }, 
            {
              "minItems": 0, 
              "items": {
                "type": "object", 
                "properties": {
                  "operator": {
                    "enum": [
                      "append", 
                      "insert", 
                      "replace", 
                      "trim", 
                      "union"
                    ], 
                    "type": "string", 
                    "description": "Specifies the operator to make rules on specified users or groups."
                  }, 
                  "user2": {
                    "type": [
                      {
                        "type": "object", 
                        "properties": {
                          "domain": {
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the domain of the user that is being mapped."
                          }, 
                          "user": {
                            "required": true, 
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the name of the user that is being mapped."
                          }
                        }
                      }, 
                      {
                        "type": "null"
                      }
                    ]
                  }, 
                  "options": {
                    "type": [
                      {
                        "type": "object", 
                        "description": "Specifies the properties for user mapping rules.", 
                        "properties": {
                          "break": {
                            "type": "boolean", 
                            "description": "If true, and the rule was applied successfully, stop processing further."
                          }, 
                          "group": {
                            "type": "boolean", 
                            "description": "If true, the primary GID and primary group SID should be copied to the existing credential."
                          }, 
                          "user": {
                            "type": "boolean", 
                            "description": "If true, the primary UID and primary user SID should be copied to the existing credential."
                          }, 
                          "groups": {
                            "type": "boolean", 
                            "description": "If true, all additional identifiers should be copied to the existing credential."
                          }, 
                          "default_user": {
                            "type": [
                              {
                                "type": "object", 
                                "properties": {
                                  "domain": {
                                    "type": [
                                      {
                                        "minLength": 0, 
                                        "type": "string", 
                                        "maxLength": 255
                                      }, 
                                      {
                                        "type": "null"
                                      }
                                    ], 
                                    "description": "Specifies the domain of the user that is being mapped."
                                  }, 
                                  "user": {
                                    "required": true, 
                                    "type": [
                                      {
                                        "minLength": 0, 
                                        "type": "string", 
                                        "maxLength": 255
                                      }, 
                                      {
                                        "type": "null"
                                      }
                                    ], 
                                    "description": "Specifies the name of the user that is being mapped."
                                  }
                                }
                              }, 
                              {
                                "type": "null"
                              }
                            ]
                          }
                        }
                      }, 
                      {
                        "type": "null"
                      }
                    ]
                  }, 
                  "user1": {
                    "required": true, 
                    "type": [
                      {
                        "type": "object", 
                        "properties": {
                          "domain": {
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the domain of the user that is being mapped."
                          }, 
                          "user": {
                            "required": true, 
                            "type": [
                              {
                                "minLength": 0, 
                                "type": "string", 
                                "maxLength": 255
                              }, 
                              {
                                "type": "null"
                              }
                            ], 
                            "description": "Specifies the name of the user that is being mapped."
                          }
                        }
                      }
                    ], 
                    "description": "Specifies the first user this rule apples to."
                  }
                }
              }, 
              "type": "array", 
              "description": "Specifies the list of user mapping rules.", 
              "maxItems": 4294967295
            }
          ]
        }, 
        "parameters": {
          "type": [
            {
              "enum": [
                "@DEFAULT"
              ], 
              "type": "string"
            }, 
            {
              "type": "object", 
              "description": "Specifies the default UNIX user information that can be applied if the final credentials do not have valid UID and GID information.", 
              "properties": {
                "default_unix_user": {
                  "type": [
                    {
                      "type": "object", 
                      "properties": {
                        "domain": {
                          "type": [
                            {
                              "minLength": 0, 
                              "type": "string", 
                              "maxLength": 255
                            }, 
                            {
                              "type": "null"
                            }
                          ], 
                          "description": "Specifies the domain of the user that is being mapped."
                        }, 
                        "user": {
                          "required": true, 
                          "type": [
                            {
                              "minLength": 0, 
                              "type": "string", 
                              "maxLength": 255
                            }, 
                            {
                              "type": "null"
                            }
                          ], 
                          "description": "Specifies the name of the user that is being mapped."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ]
                }
              }
            }
          ]
        }
      }
    }
  ]
}

There is no JSON response body for this method.
