com.quantum.dxi.rest.dxi

Class Users

java.lang.Object

Base

com.quantum.dxi.rest.dxi.Users

public class Users
extends Base

The Users resource represents user accounts on the system. The Users interface includes services for starting a system Web Services authenticated session, checking the permissions of the authenticted user, and terminating the session.

The schema that defines the Users resource is defined below.

 
    <xs:element name="Users">
        <xs:annotation>
            <xs:documentation>Only used by Simulation DAO</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="User" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="User">
        <xs:annotation>
            <xs:documentation>Only used by Simulation DAO</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="Credentials"/>
                <xs:element ref="Permissions"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Credentials">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="UserName" type="xs:string"/>
                <xs:element name="Password" type="xs:string"/>
                <xs:element name="ClientInfo"  type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>ClientInfo is deprecated as of version 1.2 and is ignored.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Permissions">
        <xs:annotation>
            <xs:documentation>Multiple permissions</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="Permission" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Permission">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Name" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>Scope of access for the current session: system.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="UserAccess" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>None, ReadOnly, or ReadWrite</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="MfaCredentials">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="UserName" type="xs:string" minOccurs="0"/>
                <xs:element name="Password" type="xs:string" minOccurs="0"/>
                <xs:element name="Totp"  type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="MfaState">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotpRequired" type="xs:boolean" minOccurs="0"/>
                <xs:element name="SharedKey"  type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

Modifier and Type	Method and Description
Permissions	authenticate(javax.servlet.http.HttpServletRequest request, Credentials credentials) POST /rest/Users/RESTAuthenticate
StringScalarType	authenticate(javax.servlet.http.HttpServletRequest request, String actionString, Credentials credentials) Deprecated. As of 1.1, ?action=authenticate replaced by @see #authenticate(HttpServletRequest, Credentials) and @see #authenticateGUI(HttpServletRequest, Credentials)
StringScalarType	authenticateGUI(javax.servlet.http.HttpServletRequest request, Credentials credentials) POST /rest/Users/authenticate
Permissions	deAuthenticate(javax.servlet.http.HttpServletRequest request, String actionString) Deprecated. As of 1.1, ?action=deAuthenticate replaced by logout(HttpServletRequest)
StringScalarType	getAuthenticationToken(javax.servlet.http.HttpServletRequest request) GET /rest/Users/authenticationToken
Permissions	getPermissions(javax.servlet.http.HttpServletRequest request) GET /rest/Users/getPermissions
Permissions	getPermissions(javax.servlet.http.HttpServletRequest request, String actionString) Deprecated. As of 1.1, ?action=getPermissions replaced by getPermissions(HttpServletRequest)
javax.ws.rs.core.Response	logout(javax.servlet.http.HttpServletRequest request) POST /rest/Users/logout
javax.ws.rs.core.Response	mfa_authenticate(javax.servlet.http.HttpServletRequest request, String mfaType, MfaCredentials credentials) POST /rest/Users/mfa/{mfaType}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Users

public Users()

Method Detail

authenticateGUI

public StringScalarType authenticateGUI(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        Credentials credentials)

POST /rest/Users/authenticate

Establish an authenticated session with the system Web Services. You must successfully authenticate before any other web service calls will succeed. The HTTP Response will include a Set-Cookie: JSESSIONID=<session-id> header; this cookie identifies the authenticated session and must be passed in a Cookie header in all subsequent web service calls. Upon successful authentication, the response includes an authentication token that can be used to perform additional authentication with the Quantum system GUI legacy cgi-bin pages.

Note: This service is specific to needs of the system GUI legacy pages, and is not generally needed by system REST Web Service clients.

Request Entity type: <xs:element name="Credentials">

Response Entity type: <xs:element name="StringScalarType">

Since:

1.1

authenticate

public Permissions authenticate(@Context
                                javax.servlet.http.HttpServletRequest request,
                                Credentials credentials)

POST /rest/Users/RESTAuthenticate

Establish an authenticated session with the system Web Services. You must successfully authenticate before any other web service calls will succeed. The HTTP Response will include a Set-Cookie: JSESSIONID=<session-id> header; this cookie identifies the authenticated session and must be passed in a Cookie header in all subsequent web service calls. Upon successful authentication, the response includes the authenticated user's permissions.

Request Entity type: <xs:element name="Credentials">

Response Entity type: <xs:element name="Permissions">

Since:

1.1

authenticate

public StringScalarType authenticate(@Context
                                     javax.servlet.http.HttpServletRequest request,
                                     String actionString,
                                     Credentials credentials)

Deprecated. As of 1.1, ?action=authenticate replaced by @see #authenticate(HttpServletRequest, Credentials) and @see #authenticateGUI(HttpServletRequest, Credentials)

POST /rest/Users

Establish an authenticated session with the system Web Services. You must successfully authenticate before any other web service calls will succeed. The HTTP Response will include a Set-Cookie: JSESSIONID=<session-id> header; this cookie identifies the authenticated session and must be passed in a Cookie header in all subsequent web service calls.

Request Entity type: <xs:element name="Credentials">

Response Entity type: <xs:element name="StringScalarType">

The response data can be ignored.

mfa_authenticate

public javax.ws.rs.core.Response mfa_authenticate(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  String mfaType,
                                                  MfaCredentials credentials)

POST /rest/Users/mfa/{mfaType}

This API is intended for use when multi-factor authentication (MFA) is enabled on the system. Currently only time-based one-time passwords (TOTP), mfaType = "totp" are supported.

Establish an authenticated session with the system Web Services. You must successfully authenticate before any other web service calls will succeed. If the request does not contain a TOTP and a shared key has not been saved for the username the response will be 200 (ok) and response entity will contain sharedKey and TotpRequired will be true. If the request does not contain a TOTP and the shared key has been saved, the response will be 200 (ok) and the reponse entity will not contain sharedKey and TotpRequired will be true. If the request contains a TOTP, and authentication is successful, the HTTP response will be 204 (no content). The HTTP 204 response will include a Set-Cookie: JSESSIONID=<session-id> header; this cookie identifies the authenticated session and must be passed in a cookie header in all subsequent web service calls.

Request Entity type: <xs:element name="MfaCredentials">

Response Entity type: <xs:element name="MfaState">

Since:

1.2.5

getPermissions

public Permissions getPermissions(@Context
                                  javax.servlet.http.HttpServletRequest request)

GET /rest/Users/getPermissions

Get the permissions of the user associated with the authenticated session.

Response Entity type: <xs:element name="Permissions">

Since:

1.1

getPermissions

public Permissions getPermissions(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  String actionString)

Deprecated. As of 1.1, ?action=getPermissions replaced by getPermissions(HttpServletRequest)

GET /rest/Users

Get the permissions of the user associated with the authenticated session.

The URI must include the ?action=getPermissions query parameter.

Response Entity type: <xs:element name="Permissions">

getAuthenticationToken

public StringScalarType getAuthenticationToken(@Context
                                               javax.servlet.http.HttpServletRequest request)

GET /rest/Users/authenticationToken

Get the authentication token that can be used to perform additional authentication with the Quantum system GUI legacy cgi-bin pages.

Response Entity type: <xs:element name="StringScalarType">

Since:

1.2.5

logout

public javax.ws.rs.core.Response logout(@Context
                                        javax.servlet.http.HttpServletRequest request)

POST /rest/Users/logout

Invalidate (close) the authenticated session. This effectively "logs out" the user.

Since:

1.1

deAuthenticate

public Permissions deAuthenticate(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  String actionString)

Deprecated. As of 1.1, ?action=deAuthenticate replaced by logout(HttpServletRequest)

PUT /rest/Users

Perform an action on the authenticated session. The action must be passed as a query parameter.

The supported actions are:

• action=deAuthenticate end the authenticated session.

Response Entity type: <xs:element name="Permissions">

A default (empty) Permissions entity is returned, and can be ignored.