Endpoint

/v1/identity/expand

POST

Find all equivalents and the group membership of the given identity.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_id_to_expand",
  "type": "object",
  "properties": {
    "id": {
      "description": "The identity to expand.",
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "enum": [
            "LOCAL",
            "API_NULL_DOMAIN",
            "WORLD",
            "POSIX_USER",
            "POSIX_GROUP",
            "ACTIVE_DIRECTORY",
            "API_INVALID_DOMAIN",
            "API_RESERVED_DOMAIN",
            "API_INTERNAL_DOMAIN",
            "API_OPERATOR_DOMAIN",
            "API_CREATOR_DOMAIN"
          ],
          "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
        },
        "auth_id": {
          "description": "auth_id",
          "type": "string"
        },
        "uid": {
          "description": "uid",
          "type": "number"
        },
        "gid": {
          "description": "gid",
          "type": "number"
        },
        "sid": {
          "description": "sid",
          "type": "string"
        },
        "name": {
          "description": "name",
          "type": "string"
        }
      }
    },
    "equivalent_ids": {
      "type": "array",
      "items": {
        "description": "Additional identities that should be considered equivalent, and also expanded.",
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "enum": [
              "LOCAL",
              "API_NULL_DOMAIN",
              "WORLD",
              "POSIX_USER",
              "POSIX_GROUP",
              "ACTIVE_DIRECTORY",
              "API_INVALID_DOMAIN",
              "API_RESERVED_DOMAIN",
              "API_INTERNAL_DOMAIN",
              "API_OPERATOR_DOMAIN",
              "API_CREATOR_DOMAIN"
            ],
            "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
          },
          "auth_id": {
            "description": "auth_id",
            "type": "string"
          },
          "uid": {
            "description": "uid",
            "type": "number"
          },
          "gid": {
            "description": "gid",
            "type": "number"
          },
          "sid": {
            "description": "sid",
            "type": "string"
          },
          "name": {
            "description": "name",
            "type": "string"
          }
        }
      }
    },
    "group_ids": {
      "type": "array",
      "items": {
        "description": "Additional groups that the id should be considered a member of, and also expanded.",
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "enum": [
              "LOCAL",
              "API_NULL_DOMAIN",
              "WORLD",
              "POSIX_USER",
              "POSIX_GROUP",
              "ACTIVE_DIRECTORY",
              "API_INVALID_DOMAIN",
              "API_RESERVED_DOMAIN",
              "API_INTERNAL_DOMAIN",
              "API_OPERATOR_DOMAIN",
              "API_CREATOR_DOMAIN"
            ],
            "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
          },
          "auth_id": {
            "description": "auth_id",
            "type": "string"
          },
          "uid": {
            "description": "uid",
            "type": "number"
          },
          "gid": {
            "description": "gid",
            "type": "number"
          },
          "sid": {
            "description": "sid",
            "type": "string"
          },
          "name": {
            "description": "name",
            "type": "string"
          }
        }
      }
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_expanded_id",
  "type": "object",
  "properties": {
    "id": {
      "description": "The identity that was expanded.",
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "enum": [
            "LOCAL",
            "API_NULL_DOMAIN",
            "WORLD",
            "POSIX_USER",
            "POSIX_GROUP",
            "ACTIVE_DIRECTORY",
            "API_INVALID_DOMAIN",
            "API_RESERVED_DOMAIN",
            "API_INTERNAL_DOMAIN",
            "API_OPERATOR_DOMAIN",
            "API_CREATOR_DOMAIN"
          ],
          "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
        },
        "auth_id": {
          "description": "auth_id",
          "type": "string"
        },
        "uid": {
          "description": "uid",
          "type": "number"
        },
        "gid": {
          "description": "gid",
          "type": "number"
        },
        "sid": {
          "description": "sid",
          "type": "string"
        },
        "name": {
          "description": "name",
          "type": "string"
        }
      }
    },
    "type": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "USER",
        "GROUP"
      ],
      "description": "Whether the expanded identity is a user, group, or indeterminate.:\n * `GROUP` - RESOLVED_ID_IS_GROUP,\n * `UNKNOWN` - RESOLVED_ID_IS_UNKNOWN,\n * `USER` - RESOLVED_ID_IS_USER"
    },
    "smb_id": {
      "description": "The equivalent identity that would be shown to SMB clients.",
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "enum": [
            "LOCAL",
            "API_NULL_DOMAIN",
            "WORLD",
            "POSIX_USER",
            "POSIX_GROUP",
            "ACTIVE_DIRECTORY",
            "API_INVALID_DOMAIN",
            "API_RESERVED_DOMAIN",
            "API_INTERNAL_DOMAIN",
            "API_OPERATOR_DOMAIN",
            "API_CREATOR_DOMAIN"
          ],
          "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
        },
        "auth_id": {
          "description": "auth_id",
          "type": "string"
        },
        "uid": {
          "description": "uid",
          "type": "number"
        },
        "gid": {
          "description": "gid",
          "type": "number"
        },
        "sid": {
          "description": "sid",
          "type": "string"
        },
        "name": {
          "description": "name",
          "type": "string"
        }
      }
    },
    "nfs_id": {
      "description": "The equivalent identity that would be shown to NFS clients.",
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "enum": [
            "LOCAL",
            "API_NULL_DOMAIN",
            "WORLD",
            "POSIX_USER",
            "POSIX_GROUP",
            "ACTIVE_DIRECTORY",
            "API_INVALID_DOMAIN",
            "API_RESERVED_DOMAIN",
            "API_INTERNAL_DOMAIN",
            "API_OPERATOR_DOMAIN",
            "API_CREATOR_DOMAIN"
          ],
          "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
        },
        "auth_id": {
          "description": "auth_id",
          "type": "string"
        },
        "uid": {
          "description": "uid",
          "type": "number"
        },
        "gid": {
          "description": "gid",
          "type": "number"
        },
        "sid": {
          "description": "sid",
          "type": "string"
        },
        "name": {
          "description": "name",
          "type": "string"
        }
      }
    },
    "equivalent_ids": {
      "type": "array",
      "items": {
        "description": "Identities that are the same as the expanded ID, and which have the same rights.",
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "enum": [
              "LOCAL",
              "API_NULL_DOMAIN",
              "WORLD",
              "POSIX_USER",
              "POSIX_GROUP",
              "ACTIVE_DIRECTORY",
              "API_INVALID_DOMAIN",
              "API_RESERVED_DOMAIN",
              "API_INTERNAL_DOMAIN",
              "API_OPERATOR_DOMAIN",
              "API_CREATOR_DOMAIN"
            ],
            "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
          },
          "auth_id": {
            "description": "auth_id",
            "type": "string"
          },
          "uid": {
            "description": "uid",
            "type": "number"
          },
          "gid": {
            "description": "gid",
            "type": "number"
          },
          "sid": {
            "description": "sid",
            "type": "string"
          },
          "name": {
            "description": "name",
            "type": "string"
          }
        }
      }
    },
    "group_ids": {
      "type": "array",
      "items": {
        "description": "Groups that the expanded ID is a member of.",
        "type": "object",
        "properties": {
          "domain": {
            "type": "string",
            "enum": [
              "LOCAL",
              "API_NULL_DOMAIN",
              "WORLD",
              "POSIX_USER",
              "POSIX_GROUP",
              "ACTIVE_DIRECTORY",
              "API_INVALID_DOMAIN",
              "API_RESERVED_DOMAIN",
              "API_INTERNAL_DOMAIN",
              "API_OPERATOR_DOMAIN",
              "API_CREATOR_DOMAIN"
            ],
            "description": "domain:\n * `ACTIVE_DIRECTORY` - ACTIVE_DIRECTORY,\n * `API_CREATOR_DOMAIN` - API_CREATOR_DOMAIN,\n * `API_INTERNAL_DOMAIN` - API_INTERNAL_DOMAIN,\n * `API_INVALID_DOMAIN` - API_INVALID_DOMAIN,\n * `API_NULL_DOMAIN` - API_NULL_DOMAIN,\n * `API_OPERATOR_DOMAIN` - API_OPERATOR_DOMAIN,\n * `API_RESERVED_DOMAIN` - API_RESERVED_DOMAIN,\n * `LOCAL` - LOCAL,\n * `POSIX_GROUP` - POSIX_GROUP,\n * `POSIX_USER` - POSIX_USER,\n * `WORLD` - WORLD"
          },
          "auth_id": {
            "description": "auth_id",
            "type": "string"
          },
          "uid": {
            "description": "uid",
            "type": "number"
          },
          "gid": {
            "description": "gid",
            "type": "number"
          },
          "sid": {
            "description": "sid",
            "type": "string"
          },
          "name": {
            "description": "name",
            "type": "string"
          }
        }
      }
    }
  }
}