Difference between revisions of "Active User Web Service"

From FMR Knowledge Base
Jump to navigation Jump to search
(Created page with "Category:FMR_REST_API_Reference To be written.")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[Category:FMR_REST_API_Reference]]
 
[[Category:FMR_REST_API_Reference]]
 +
= Overview =
 +
The Active User web service can be used by an authenticated user to return details of their account.
  
To be written.
+
Returns JSON describing:
 +
* Root user permissions (if any)
 +
* Admin permissions (if any)
 +
* User name
 +
* Registered email address
 +
* Modify permissions
 +
* SDMX Data Consumer organisation membership
 +
* SDMX Data Provider organisation membership
 +
* SDMX Agency membership
 +
 
 +
{| class="wikitable"
 +
|-
 +
|style="background-color:#eaecf0"|<b>Entry Point</b> || style="min-width:500px;" | <b> /ws/public/currentuser/user</b>
 +
|-
 +
|style="background-color:#eaecf0"|<b>Access</b> || Public </span>
 +
|-
 +
|style="background-color:#eaecf0"|<b>Http Method</b> || GET
 +
|-
 +
|style="background-color:#eaecf0"|<b>Response Format</b> || application/json (array  of objects)
 +
|-
 +
|style="background-color:#eaecf0"|<b>Response Statuses</b> || <p><b>200</b> - Query Ok<p>
 +
|}
 +
 
 +
=Example=
 +
[[File:ActiveUserJSON.PNG]]

Latest revision as of 10:24, 18 March 2021

Overview

The Active User web service can be used by an authenticated user to return details of their account.

Returns JSON describing:

  • Root user permissions (if any)
  • Admin permissions (if any)
  • User name
  • Registered email address
  • Modify permissions
  • SDMX Data Consumer organisation membership
  • SDMX Data Provider organisation membership
  • SDMX Agency membership
Entry Point /ws/public/currentuser/user
Access Public
Http Method GET
Response Format application/json (array of objects)
Response Statuses

200 - Query Ok

Example

ActiveUserJSON.PNG