== stoney mail ==
<pre>
stoney mail: Mail Domains Resource - REST API
stoney mail: Mail Accounts Resource - REST API
https://api.example.com/v1/services/mail
https://api.example.com/v1/services/mail/domains
https://api.example.com/v1/services/mail/domains/stepping-stone.ch5000000https://api.example.com/v1/services/mail/domains/stepping-stone5000000/accountshttps://api.chexample.com/v1/services/mail/domains/5000000/accounts/5000001https://api.example.com/v1/services/mail/domains/stepping-stone5000000/aliases/5000002https://api.chexample.com/accountsv1/michaelservices/mail/domainaliaseshttps://api.eichenbergerexample.com/v1/services/mail/domainaliases/5000003
https://api.example.com/v1/services/mail/accounts
https://api.example.com/v1/services/mail/accounts/michael.eichenberger@stepping-stone.ch</pre> == stoney vm ==<pre>stoney vm: Virtual Machines Resource - REST API5000001https://api.example.com/v1/services/vmhttps://api.example.com/v1/services/vm/vmshttps://api.example.com/v1/services/vm/vmsmail/kvm-0211aliaseshttps://api.example.com/v1/services/vmmail/vmsaliases/37123455000002
</pre>
How to we hande actions (start/stop/...)?
= Notes = Permission & Ownership object ==* Points we We need a generic permission & ownership object which can be added to discuss --[[Userall service creation and modification requests. The following points needs to be clarified:Chrigu|Chrigu]] ([[User talk:Chrigu|talk]]) 09:35, 30 January 2014 (CET)*Shall the roles be set during the service creation / modification or on the users resource?* services vsIs this object always mandatory, or can the roles be defined via some clever inherited default values if missing. products*Which roles are available and can be set on which level** Product: stone mail, stoney vm, stoney backup --[[User:Michael|Michael]] Which informations apart from the user ([[User talk:Michael|talk]]) 09:47, 30 January 2014 (CETpeople)and the role name are necessary?*** Service: mail domains and accounts, backup accounts, virtual machines (as defined in Do we want to reference the directory under ou=services https://api.example.com/v1/services/vm/vmslocation URI or the UID of a role** product UIDs vs. names (Does anyone have a better name for the <code>mail/12345678roles</code> vs. <code>mail/example.com</code>)*** Maybe both should workobject? If not, uid would be preferable, as they stay fix, even if you rename the mail account. --[[User:Michael|Michael]] ([[User talk:Michael|talk]]) 09:47, 30 January 2014 (CET)** Maybe create examples for other products/services to get a feeling about what is the better, more generic way.*** See above. --[[User:Michael|Michael]] ([[User talk:Michael|talk]]) 09:47, 30 January 2014 (CET)
<source lang="javascript">
"roles":
{
[
{
/* The user 3000000 has the Admin role for this service */
"location": "https://api.example.com/v1/users/3000000",
"role": "Admin"
},
{
/* The user 3000001 has the Admin role for this service */
"location": "https://api.example.com/v1/users/3000001",
"role": "Admin"
},
{
/* The user 3000002 has the User role for this service */
"location": "https://api.example.com/v1/users/3000002",
"role": "User"
},
{
/* ... */
}
]
}
</source>
The opposite while querying a users resource, for example https://api.example.com/v1/users/3000000
<source lang="javascript">
"roles":
{
[
{
/* MailAccountAdmin role for the mail account 5000001 */
"location": "https://api.example.com/v1/services/mail/domains/5000000/accounts/5000001",
"role": "Admin"
},
{
/* BackupAdmin role for all backup products of the customer 1000001 */
"location": "https://api.example.com/v1/services/backups/accounts/?customerUid=1000001",
"role": "Admin"
},
{
/* VirtualizationUser role for the VM 6000001 */
"location": "https://api.example.com/v1/services/virtualization/vms/6000001",
"role": "User"
},
{
/* ... */
}
]
}
</source>
== Notes ==
* We need to be able to query the size of the mailbox and the used space. Do we also return the percentage of used space or do we let the client calculate this value?
[[Category:REST API]][[Category:stoney mail]]