User Role Management APIs User Console Resource

The UserConsoleResource service provides both shared and user-specific state or settings related with the use of the Pentaho User Console.

Check if user is administrator

get

Returns whether the current user is an administrator.

Example Request:

GET pentaho/api/mantle/isAdministrator

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/mantle/isAdministrator" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Example Response:

true

Returns: String true if the user is an administrator, or false otherwise.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Responses

200

Returns the boolean response

text/plain

stringOptional

Boolean value indicating administrator status

get

/mantle/isAdministrator

HTTPcURLJavaScriptPython

GET /mantle/isAdministrator HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Returns the boolean response

true

Check if user is authenticated

get

Returns whether the user is an authenticated user or not.

Example Request:

GET pentaho/api/mantle/isAuthenticated

cURL Example:

curl -X GET \
  "http://localhost:8080/pentaho/api/mantle/isAuthenticated" \
  -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ="

Example Response:

true

Returns: String true if the user is authenticated, or false otherwise.

Authorizations

basicAuth

AuthorizationstringRequired

HTTP Basic Authentication

Responses

200

Returns the boolean response

text/plain

stringOptional

Boolean value indicating authentication status

401

User is not authenticated

get

/mantle/isAuthenticated

HTTPcURLJavaScriptPython

GET /mantle/isAuthenticated HTTP/1.1
Authorization: Basic username:password
Accept: */*

true