{"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"}}}
PUT
Set configuration of a tenant.
Parameters
Name
Description
Required
tenant_id
The unique ID of the tenant
Yes
If-Match
ETag for expected version
No
Request
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"}}}
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"}}}
DELETE
Delete configuration of a tenant.
Parameters
Name
Description
Required
tenant_id
The unique ID of the tenant
Yes
If-Match
ETag for expected version
No
Response
Codes
Code
Description
200
Return value on success
PATCH
Update the configuration of a tenant.
Parameters
Name
Description
Required
tenant_id
The unique ID of the tenant
Yes
If-Match
ETag for expected version
No
Request
Schema
{"description":"api_tenant_config_patch","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"}}}
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"}}}
