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

    Overview: This resource allows user lookup.

     Methods: GET

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

Method GET: Retrieve the user information.

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

Query arguments:
      primary_gid=<integer> The user's primary group ID.
              uid=<integer> The user ID.
              zone=<string> The zone the user belongs to.
              gid=<integer> The IDs of the groups that the user belongs to.
              user=<string> The user name.
kerberos_principal=<string> The Kerberos principal name, of the form user@realm.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "mapping": {
      "items": {
        "type": "object", 
        "properties": {
          "privileges": {
            "items": {
              "type": "object", 
              "description": "Specifies the system-defined privilege that may be granted to users.", 
              "properties": {
                "read_only": {
                  "type": "boolean", 
                  "description": "True, if the privilege is read-only."
                }, 
                "id": {
                  "required": true, 
                  "type": "string", 
                  "description": "Specifies the ID of the privilege."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the name of the privilege."
                }
              }
            }, 
            "type": "array"
          }, 
          "zid": {
            "type": [
              "integer", 
              "null"
            ]
          }, 
          "zone": {
            "type": [
              "string", 
              "null"
            ]
          }, 
          "user": {
            "type": "object", 
            "description": "Specifies the configuration properties for a user.", 
            "properties": {
              "domain": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies the domain that the object is part of."
              }, 
              "generated_gid": {
                "required": true, 
                "type": [
                  "boolean", 
                  "null"
                ], 
                "description": "True, if the GID was generated."
              }, 
              "on_disk_group_identity": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the group identity on the disk."
              }, 
              "uid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies an ID for the user."
              }, 
              "password_expires": {
                "required": true, 
                "type": "boolean", 
                "description": "If true, the password is allowed to expire."
              }, 
              "sam_account_name": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies a user or group name."
              }, 
              "dns_domain": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies the DNS domain."
              }, 
              "password_expired": {
                "required": true, 
                "type": "boolean", 
                "description": "If true, the password has expired."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "Specifies the user or group ID."
              }, 
              "generated_upn": {
                "required": true, 
                "type": [
                  "boolean", 
                  "null"
                ], 
                "description": "True, if the UPN was generated."
              }, 
              "password_last_set": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "Specifies the last time the password was set."
              }, 
              "gid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies a group ID for the user."
              }, 
              "provider": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies the authentication provider that the object belongs to."
              }, 
              "max_password_age": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "Specifies the maximum time in seconds allowed before the password expires."
              }, 
              "type": {
                "required": true, 
                "type": "string", 
                "description": "Specifies the object type."
              }, 
              "email": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies an email address."
              }, 
              "dn": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies the distinguished name for the user."
              }, 
              "shell": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies a path to the shell for the user."
              }, 
              "sid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }
                ], 
                "description": "Specifies the security identifier."
              }, 
              "expiry": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "Specifies the Unix Epoch time at which the authenticated user will expire."
              }, 
              "on_disk_user_identity": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the user identity on the disk."
              }, 
              "password_expiry": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "Specifies the time in Unix Epoch seconds that the password will expire."
              }, 
              "user_can_change_password": {
                "required": true, 
                "type": "boolean", 
                "description": "Specifies whether the password for the user can be changed."
              }, 
              "expired": {
                "required": true, 
                "type": "boolean", 
                "description": "True, if the authenticated user has expired."
              }, 
              "upn": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies a principal name for the user."
              }, 
              "locked": {
                "required": true, 
                "type": "boolean", 
                "description": "If true, indicates that the account is locked."
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "Specifies a user or group name."
              }, 
              "member_of": {
                "required": true, 
                "type": [
                  {
                    "type": "null"
                  }, 
                  {
                    "items": {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }, 
                    "type": "array"
                  }
                ], 
                "description": "Specifies the groups that this user or group are members of."
              }, 
              "enabled": {
                "required": true, 
                "type": "boolean", 
                "description": "True, if the authenticated user is enabled."
              }, 
              "primary_group_sid": {
                "required": true, 
                "type": [
                  {
                    "type": "object", 
                    "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                    "properties": {
                      "type": {
                        "enum": [
                          "user", 
                          "group", 
                          "wellknown"
                        ], 
                        "type": "string", 
                        "description": "Specifies the type of persona, which must be combined with a name."
                      }, 
                      "id": {
                        "type": "string", 
                        "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                      }, 
                      "name": {
                        "type": "string", 
                        "description": "Specifies the persona name, which must be combined with a type."
                      }
                    }
                  }
                ], 
                "description": "Specifies the security ID of the primary group for the user."
              }, 
              "gecos": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies the GECOS value, which is usually the full name."
              }, 
              "generated_uid": {
                "required": true, 
                "type": [
                  "boolean", 
                  "null"
                ], 
                "description": "True, if the UID was generated."
              }, 
              "home_directory": {
                "required": true, 
                "type": [
                  "string", 
                  "null"
                ], 
                "description": "Specifies a home directory for the user."
              }, 
              "prompt_password_change": {
                "required": true, 
                "type": "boolean", 
                "description": "Prompts the user to change their password at the next login."
              }
            }
          }, 
          "groups": {
            "items": {
              "type": "object", 
              "description": "Specifies the configuration properties for a user.", 
              "properties": {
                "domain": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the domain that the object is part of."
                }, 
                "generated_gid": {
                  "required": false, 
                  "type": [
                    "boolean", 
                    "null"
                  ], 
                  "description": "If true, indicates that the GID was generated."
                }, 
                "on_disk_group_identity": {
                  "required": false, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ], 
                  "description": "Specifies the group identity on the disk."
                }, 
                "uid": {
                  "required": false, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ], 
                  "description": "Specifies the user ID."
                }, 
                "password_expires": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the password is allowed to expire."
                }, 
                "sam_account_name": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies a user or group name."
                }, 
                "dns_domain": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the DNS domain."
                }, 
                "password_expired": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the password has expired."
                }, 
                "id": {
                  "required": true, 
                  "type": "string", 
                  "description": "Specifies the user or group ID."
                }, 
                "generated_upn": {
                  "required": false, 
                  "type": [
                    "boolean", 
                    "null"
                  ], 
                  "description": "If true, indicates that the UPN was generated."
                }, 
                "password_last_set": {
                  "required": false, 
                  "type": [
                    "integer", 
                    "null"
                  ], 
                  "description": "Specifies the last time the password was set."
                }, 
                "gid": {
                  "required": false, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ], 
                  "description": "Specifies a group ID for the user."
                }, 
                "provider": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the authentication provider that the object belongs to."
                }, 
                "max_password_age": {
                  "required": false, 
                  "type": [
                    "integer", 
                    "null"
                  ], 
                  "description": "Specifies the maximum time in seconds allowed before the password expires."
                }, 
                "type": {
                  "required": true, 
                  "type": "string", 
                  "description": "Specifies the object type."
                }, 
                "email": {
                  "required": false, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies an email address."
                }, 
                "dn": {
                  "required": true, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the distinguished name for the user."
                }, 
                "shell": {
                  "required": false, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the path to the shell for the user."
                }, 
                "sid": {
                  "required": true, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }
                  ], 
                  "description": "Specifies the security identifier."
                }, 
                "expiry": {
                  "required": false, 
                  "type": [
                    "integer", 
                    "null"
                  ], 
                  "description": "Specifies the Epoch time at which the authenticated user will expire."
                }, 
                "on_disk_user_identity": {
                  "required": false, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }, 
                    {
                      "type": "null"
                    }
                  ], 
                  "description": "Specifies the user identity on the disk."
                }, 
                "password_expiry": {
                  "required": false, 
                  "type": [
                    "integer", 
                    "null"
                  ], 
                  "description": "Specifies the time in Epoch seconds the password will expire."
                }, 
                "user_can_change_password": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the user password can be changed."
                }, 
                "expired": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the authenticated auth user is expired."
                }, 
                "upn": {
                  "required": false, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the user principal name."
                }, 
                "locked": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the account is locked out."
                }, 
                "name": {
                  "required": true, 
                  "type": "string", 
                  "description": "Specifies a user or group name."
                }, 
                "member_of": {
                  "required": true, 
                  "type": [
                    {
                      "type": "null"
                    }, 
                    {
                      "items": {
                        "type": "object", 
                        "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                        "properties": {
                          "type": {
                            "enum": [
                              "user", 
                              "group", 
                              "wellknown"
                            ], 
                            "type": "string", 
                            "description": "Specifies the type of persona, which must be combined with a name."
                          }, 
                          "id": {
                            "type": "string", 
                            "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                          }, 
                          "name": {
                            "type": "string", 
                            "description": "Specifies the persona name, which must be combined with a type."
                          }
                        }
                      }, 
                      "type": "array"
                    }
                  ], 
                  "description": "Specifies the groups that this user or group are members of."
                }, 
                "enabled": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, the authenticated user is enabled."
                }, 
                "primary_group_sid": {
                  "required": false, 
                  "type": [
                    {
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                        }, 
                        "name": {
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type."
                        }
                      }
                    }
                  ], 
                  "description": "Specifies the security ID of the primary group for the user."
                }, 
                "gecos": {
                  "required": false, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the GECOS value, which is usually the full name."
                }, 
                "generated_uid": {
                  "required": false, 
                  "type": [
                    "boolean", 
                    "null"
                  ], 
                  "description": "If true, indicates that the UID was generated."
                }, 
                "home_directory": {
                  "required": false, 
                  "type": [
                    "string", 
                    "null"
                  ], 
                  "description": "Specifies the home directory for the user."
                }, 
                "prompt_password_change": {
                  "required": false, 
                  "type": "boolean", 
                  "description": "If true, prompts the user to change their password on next login."
                }
              }
            }, 
            "type": "array"
          }
        }
      }, 
      "type": "array", 
      "description": "Lookup a user access token."
    }
  }
}
