GET:site/roles

Overview

public. Retrieve list of defined roles

Message Format

Output:

<roles>
    <permissions>
        <operations mask="{int}">{text}</operations> 
        <role id="{int}" href="{uri}">{text}</role> 
    </permissions>
    ...
</roles>

Implementation Notes

Use GET:site/operations to retrieve a list of all operations currently defined on the site. 

Code Samples

The following code example retrieves a list of roles currently defined on the site:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("site", "roles").Get();

Sample response:

<roles href="http://deki-hayes/@api/deki/site/roles">
    <permissions>
        <operations mask="0" /> 
        <role id="1" href="http://deki-hayes/@api/deki/site/roles/1">None</role> 
    </permissions>
    <permissions>
        <operations mask="1">LOGIN</operations> 
        <role id="2" href="http://deki-hayes/@api/deki/site/roles/2">Guest</role> 
    </permissions>
    <permissions>
        <operations mask="15">LOGIN,BROWSE,READ,SUBSCRIBE</operations> 
        <role id="3" href="http://deki-hayes/@api/deki/site/roles/3">Viewer</role> 
    </permissions>
    <permissions>
        <operations mask="1343">LOGIN,BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS</operations> 
        <role id="4" href="http://deki-hayes/@api/deki/site/roles/4">Contributor</role> 
    </permissions>
    <permissions>
        <operations mask="9223372036854779903">LOGIN,BROWSE,READ,SUBSCRIBE,UPDATE,CREATE,DELETE,CHANGEPERMISSIONS,CONTROLPANEL,ADMIN</operations> 
        <role id="5" href="http://deki-hayes/@api/deki/site/roles/5">Admin</role> 
    </permissions>
</roles>