Skip to main content
Pentaho Documentation

User Console Resource

Overview

Provides the ability to check whether the current user is authenticated and/or is an administrator.

Overview

The UserConsoleResource service provides the ability to check whether the current user is authenticated and/or is an administrator.

The following resources are applicable:

/mantle/isAdministrator

GET

Returns whether the current user is an administrator.

Example Request:
GET pentaho-di/api/mantle/isAdministrator

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

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

Example Response:

true

Status Codes

code description
200 Returns the boolean response

/mantle/isAuthenticated

GET

Returns whether the user is sn authenticated user or not.

Example Request:
GET pentaho-di/api/mantle/isAuthenticated

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

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

Example Response:

true

Status Codes

code description
200 Returns the boolean response
401 User is not authenticated

Copyright © Pentaho.com
Generated by Enunciate.