Endpoint

/v1/multitenancy/tenants/

GET

Get configurations of all tenants.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_tenant_configs",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "List of tenant configs",
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique identifier for this tenant configuration.",
            "type": "number"
          },
          "name": {
            "description": "Unique name of the tenant chosen by the user.",
            "type": "string"
          },
          "web_ui_enabled": {
            "description": "Web UI is accessible from this tenant.",
            "type": "boolean"
          },
          "rest_api_enabled": {
            "description": "Rest API is accessible from this tenant.",
            "type": "boolean"
          },
          "ssh_enabled": {
            "description": "SSH is accessible from this tenant.",
            "type": "boolean"
          },
          "replication_enabled": {
            "description": "Replication is accessible from this tenant.",
            "type": "boolean"
          },
          "nfs_enabled": {
            "description": "NFS is accessible from this tenant.",
            "type": "boolean"
          },
          "smb_enabled": {
            "description": "SMB is accessible from this tenant.",
            "type": "boolean"
          },
          "networks": {
            "type": "array",
            "items": {
              "description": "List of network IDs associated with this tenant.",
              "type": "number"
            }
          },
          "identity_config_id": {
            "description": "Unique identifier for the identity configuration to use for this tenant.",
            "type": "number"
          }
        }
      }
    }
  }
}

POST

Create a tenant.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "api_tenant_config_post",
  "type": "object",
  "properties": {
    "name": {
      "description": "Unique name of the tenant chosen by the user.",
      "type": "string"
    },
    "web_ui_enabled": {
      "description": "Web UI is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "rest_api_enabled": {
      "description": "Rest API is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "ssh_enabled": {
      "description": "SSH is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "replication_enabled": {
      "description": "Replication is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "nfs_enabled": {
      "description": "NFS is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "smb_enabled": {
      "description": "SMB is accessible from this tenant. Defaults to false.",
      "type": "boolean"
    },
    "networks": {
      "type": "array",
      "items": {
        "description": "List of network IDs associated with this tenant. Defaults to empty.",
        "type": "number"
      }
    },
    "identity_config_id": {
      "description": "Unique identifier for the identity configuration to use for this tenant.",
      "type": "number"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_tenant_config",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier for this tenant configuration.",
      "type": "number"
    },
    "name": {
      "description": "Unique name of the tenant chosen by the user.",
      "type": "string"
    },
    "web_ui_enabled": {
      "description": "Web UI is accessible from this tenant.",
      "type": "boolean"
    },
    "rest_api_enabled": {
      "description": "Rest API is accessible from this tenant.",
      "type": "boolean"
    },
    "ssh_enabled": {
      "description": "SSH is accessible from this tenant.",
      "type": "boolean"
    },
    "replication_enabled": {
      "description": "Replication is accessible from this tenant.",
      "type": "boolean"
    },
    "nfs_enabled": {
      "description": "NFS is accessible from this tenant.",
      "type": "boolean"
    },
    "smb_enabled": {
      "description": "SMB is accessible from this tenant.",
      "type": "boolean"
    },
    "networks": {
      "type": "array",
      "items": {
        "description": "List of network IDs associated with this tenant.",
        "type": "number"
      }
    },
    "identity_config_id": {
      "description": "Unique identifier for the identity configuration to use for this tenant.",
      "type": "number"
    }
  }
}