Cloud Management API 1.5
ChildAccounts
Actions
index
Lists the enterprise ChildAccounts available for this Account.
- URLs
- GET /api/child_accounts
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.account;type=collection
Required roles
- enterprise_manager
Required settings
- enterprise_master
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
Filters
| name | partial_match? | description |
|---|---|---|
| name | yes | The name of the account to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"name": "SPEC_ACCOUNT",
"created_at": "2023/10/09 11:06:00 +0000",
"updated_at": "2023/10/09 11:06:00 +0000",
"links": [
{"rel":"self","href":"/api/accounts/560182816"},
{"rel":"owner","href":"/api/users/888"},
{"rel":"cluster","href":"/api/clusters/9"}
]
},{
"name": "SPEC_ACCOUNT",
"created_at": "2023/10/09 11:06:00 +0000",
"updated_at": "2023/10/09 11:06:00 +0000",
"links": [
{"rel":"self","href":"/api/accounts/560182816"},
{"rel":"owner","href":"/api/users/888"},
{"rel":"cluster","href":"/api/clusters/9"}
]
}]<?xml version="1.0" encoding="UTF-8"?>
<accounts>
<account>
<name>SPEC_ACCOUNT</name>
<created_at>2023/10/09 11:06:00 +0000</created_at>
<updated_at>2023/10/09 11:06:00 +0000</updated_at>
<links>
<link rel="self" href="/api/accounts/560182816"/>
<link rel="owner" href="/api/users/888"/>
<link rel="cluster" href="/api/clusters/9"/>
</links>
</account>
<account>
<name>SPEC_ACCOUNT</name>
<created_at>2023/10/09 11:06:00 +0000</created_at>
<updated_at>2023/10/09 11:06:00 +0000</updated_at>
<links>
<link rel="self" href="/api/accounts/560182816"/>
<link rel="owner" href="/api/users/888"/>
<link rel="cluster" href="/api/clusters/9"/>
</links>
</account>
</accounts>
create
Create an enterprise ChildAccount for this Account. The User will by default get an 'admin' role on the ChildAccount to enable him/her to add, delete Users and Permissions.
For more information on the valid values for 'cluster_href', refer to the following:
http://support.rightscale.com/12-Guides/RightScale_API_1.5/Examples/ChildAccounts/Create
- URLs
- POST /api/child_accounts
- HTTP response code
- 201 Created
- Location
- Href of the created ChildAccount
Required roles
- enterprise_manager
Required settings
- enterprise_master
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| child_account | yes | Hash | * | * | no | |
| child_account[cluster_href] | no | String | * | * | no | The href of the cluster in which to create the account. If not specified, will default to the cluster of the parent account. |
| child_account[name] | yes | String | * | * | no |
update
Update an enterprise ChildAccount for this Account.
- URLs
- PUT /api/accounts/:id
- PUT /api/child_accounts/:id
- HTTP response code
- 204 No Content
Required roles
- enterprise_manager
Required settings
- enterprise_master
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| child_account | yes | Hash | * | * | no | |
| child_account[name] | no | String | * | * | no | The updated name for the account. |