Edit an organization
Administrators can change the name, description of organizations or enable or disable them.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | securityAdmin |
HTTP method
POST /manager/api/{apiResponseType}/1.0/editOrganization.adm HTTP/1.1
Host:{manager.dsnet} id={orgId}&description={description}
Curl method
curl -u {admin}:{password}
-k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editOrganization.adm“
-d ”id={orgId}&description={dcription}“Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| id | Long | Required |
ID of organization to edit. |
|
| domain | String | Optional | The domain of the organization. | |
| name | String | Optional |
New organization name. |
|
| description | String | Optional |
New organization description. |
|
| enabled | Boolean | Optional |
Enable or disable organization. Any users in a disabled organization lose access to the Manager. |
|
| allotments |
The allotments parameter syntax is as follows, where "X" is the target storage pool ID: allotments[X].size - if a size constraint is desired, this is the numerical portion of the size constraint (partnered with "unit"). allotments[X].unit - if a size constraint is desired, this is the unit portion of the size constraint (partnered with "size"). allotments[X].unlimited - true/false indicating if a size constraint is desired (true = no constraint). allotments[X].maxAllowedVaults - this is the vault count constraint. |
Response
Returns success or failure status.
JSON response example
Default JSON success or failure response that is shown in Default JSON success response and Default JSON failure response.
Parameters
None other than the default response parameters shown in Common response parameters.