Users/Groups and Roles¶

Data Object Transfer¶

Both XML and JSON are supported for transfer of data objects. The default is XML. Alternatively, JSON may be used by setting the ‘content-type’ (POST) and ‘accept’ (GET) http headers to ‘application/json’ in your requests.

Encoding of a user in XML:

<user>
        <userName>..</userName>
        <password>..</password>
        <enabled>true/false</enabled>
</user>

Encoding of a user in JSON:

{"userName": "..", "password": "..", enabled: true/false}

Passwords are left out in results of reading requests.

Encoding of a list of users in XML:

<users>
        <user> ... </user>
        <user> ... </user>
        ...
</users>

Encoding of a list of users in JSON:

{"users":[ {..}, {..}, .. ]}

Encoding of a list of groups in XML:

<groups>
        <group> agroupname </group>
        <group> bgroupname </group>
        ...
</groups>

Encoding of a list of groups in JSON:

{"groups":[ {..}, {..}, .. ]}

Encoding of a list of roles:

<roles>
        <role> arolename </role>
        <role> brolename </role>
        ...
</roles>

Encoding of a list of roles in JSON:

{"roles":[ {..}, {..}, .. ]}

/rest/usergroup/[service/<serviceName>/]users/¶

Query all users or add a new user in a particular or the default user/group service.

/rest/usergroup/[service/<serviceName>/]user/<user>¶

Query, modify or delete a specific user in a particular or the default user/group service.

/rest/usergroup/[service/<serviceName>/]groups/¶

Query all groups in a particular user/group or the default service.

/rest/usergroup/[service/<serviceName>/]group/<group>¶

Add or delete a specific group in a particular or the default user/group service.

/rest/usergroup/[service/<serviceName>/]user/<user>/groups¶

Query all groups associated with a user in a particular or the default user/group service.

/rest/usergroup/[service/<serviceName>/]group/<group>/users¶

Query all users associated with a group in a particular or the default user/group service.

/rest/usergroup/[service/<serviceName>/]<user>/group/<group>¶

Associate or disassociate a specific user with a specific group in a particular or the default user/group service.

rest/roles/[service/{serviceName}/]¶

Query all roles in a particular role service or the active role service.

/rest/roles/[service/<serviceName>/]role/<role>¶

Add or delete a specific role in a particular role service or the active role service.

/rest/roles/[service/<serviceName>/]<serviceName>/user/<user>/roles¶

Query all roles associated with a user in a particular role service or the active role service.

/rest/roles/[service/<serviceName>/]role/<role>/user/<user>/¶

Associate or disassociate a specific user with a specific role in a particular role service or the active role service.