Changes

stoney mail: Mail Resource - REST API

2,099 bytes added, 08:42, 19 March 2014
/* Permission & Ownership object */
== 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/michael5000001https://api.eichenberger@stepping-stoneexample.chcom/v1/services/mail/aliaseshttps://api.example.com/v1/services/mail/aliases/5000002
</pre>
= Notes = Permission & Ownership object ==* Points we We need a generic permission & ownership object which can be added to all service creation and modification requests. The following points needs to discussbe clarified:*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 UIDs vs. names Which informations apart from the user (people) and the role name are necessary?* Do we want to reference the location URI or the UID of a role* Does anyone have a better name for the <code>mail/12345678roles</code> vs. object? :) <codesource lang="javascript">mail"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" }, { /* ... */ } ]}</codesource>) 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 * Maybe create examples / "location": "https://api.example.com/v1/services/mail/domains/5000000/accounts/5000001", "role": "Admin" }, { /* BackupAdmin role for other all backup productsof the customer 1000001 */ "location": "https://api.example.com/v1/services to get a feeling about what is /backups/accounts/?customerUid=1000001", "role": "Admin" }, { /* VirtualizationUser role for the betterVM 6000001 */ "location": "https://api.example.com/v1/services/virtualization/vms/6000001", more generic way "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]]
SLB, editor, reviewer
3,368
edits