com.quantum.dxi.rest.system

Class PublicKeys

java.lang.Object

Base

com.quantum.dxi.rest.system.PublicKeys

public class PublicKeys
extends Base

The PublicKeys resource represents SSH public key files for Linux user accounts on the system. The PublicKeys resource includes services for getting, adding, updating, and deleting public keys for users.

Valid user names are: cliadmin, cliviewer, and servicelogin. If the Veeam feature is enabled, veeam may be specified. The names are not case sensitive.

The schema that defines the PublicKeys resource is defined below.

 
    <xs:element name="PublicKeys">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
                <xs:element ref="PublicKey" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="PublicKey">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="UserName" type="xs:string"/>
                <xs:element name="KeyAlias" type="xs:string">
                    <xs:annotation>
                        <xs:documentation>This is the only field that can be updated once the key has been added.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="KeyData" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>The field is required to add a key, but not to update existing key alias.</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="Fingerprint" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Fingerprint is derived from KeyData and is read-only.</xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="PublicKeyColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="UserName"/>
            <xs:enumeration value="KeyAlias"/>
            <xs:enumeration value="KeyData"/>
            <xs:enumeration value="Fingerprint"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
PublicKeys()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addPublicKey_1_1(javax.servlet.http.HttpServletRequest request, PublicKey publicKey) POST /rest/PublicKeys
PublicKey	addPublicKey(javax.servlet.http.HttpServletRequest request, PublicKey publicKey) Deprecated. As of 1.1, replaced by addPublicKey_1_1(HttpServletRequest, PublicKey)
void	deletePublicKey(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String keyAlias) DELETE /rest/PublicKeys/{userName}/{keyAlias}
PublicKey	getPublicKey(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String keyAlias, java.lang.String errorType) GET /rest/PublicKeys/{userName}/{keyAlias}
com.quantum.dxi.dao.types.PublicKeys	getPublicKeys(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/PublicKeys
java.lang.Object	getPublicKeys(javax.servlet.http.HttpServletRequest request, java.lang.String userName, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String actionString, java.lang.String filterString) GET /rest/PublicKeys/{userName}
NumericScalarType	getRowCount(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) GET /rest/PublicKeys/getRowCount
NumericScalarType	getRowCount(javax.servlet.http.HttpServletRequest request, java.lang.String userName, int start, int limit, java.lang.String filterString) GET /rest/PublicKeys/{userName}/getRowCount
PublicKey	updatePublicKey(javax.servlet.http.HttpServletRequest request, java.lang.String userName, java.lang.String keyAlias, PublicKey key) PUT /rest/PublicKeys/{userName}/{keyAlias}

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicKeys

public PublicKeys()

Method Detail

getRowCount

public NumericScalarType getRowCount(@Context
                                     javax.servlet.http.HttpServletRequest request,
                                     int start,
                                     int limit,
                                     java.lang.String filterString)

GET /rest/PublicKeys/getRowCount

Get the number of public keys for all users from the system.

getRowCount supports the table query parameters for filtering by column name. Column names are defined in <xs:simpleType name="PublicKeyColumnNameType">

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

Since:

1.1

getRowCount

public NumericScalarType getRowCount(@Context
                                     javax.servlet.http.HttpServletRequest request,
                                     java.lang.String userName,
                                     int start,
                                     int limit,
                                     java.lang.String filterString)

GET /rest/PublicKeys/{userName}/getRowCount

Get the number of public keys for the specified user from the system.

getRowCount supports the table query parameters for filtering by column name. Column names are defined in <xs:simpleType name="PublicKeyColumnNameType">

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

Since:

1.1

getPublicKeys

public com.quantum.dxi.dao.types.PublicKeys getPublicKeys(@Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          int start,
                                                          int limit,
                                                          java.lang.String sortColumn,
                                                          java.lang.String sortDirection,
                                                          java.lang.String filterString)

GET /rest/PublicKeys

Get public keys for all users from the system.

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

<xs:element name="PublicKeys"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="PublicKeyColumnNameType">

Since:

1.1

getPublicKeys

public java.lang.Object getPublicKeys(@Context
                                      javax.servlet.http.HttpServletRequest request,
                                      java.lang.String userName,
                                      int start,
                                      int limit,
                                      java.lang.String sortColumn,
                                      java.lang.String sortDirection,
                                      @Deprecated
                                      java.lang.String actionString,
                                      java.lang.String filterString)

GET /rest/PublicKeys/{userName}

Get the public key data for the specified user from the system.

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

<xs:element name="PublicKeys"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="PublicKeyColumnNameType">

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getRowCount(HttpServletRequest, String, int, int, String)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount

getPublicKey

public PublicKey getPublicKey(@Context
                              javax.servlet.http.HttpServletRequest request,
                              java.lang.String userName,
                              java.lang.String keyAlias,
                              java.lang.String errorType)

GET /rest/PublicKeys/{userName}/{keyAlias}

Get a certain public key, identified by {keyAlias} and {userName} it is associated with.

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

Since:

1.1

deletePublicKey

public void deletePublicKey(@Context
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String userName,
                            java.lang.String keyAlias)

DELETE /rest/PublicKeys/{userName}/{keyAlias}

Delete the public key identified by {keyAlias} for the user identified by {userName}.

updatePublicKey

public PublicKey updatePublicKey(@Context
                                 javax.servlet.http.HttpServletRequest request,
                                 java.lang.String userName,
                                 java.lang.String keyAlias,
                                 PublicKey key)

PUT /rest/PublicKeys/{userName}/{keyAlias}

Update the public key identified by {keyAlias} for the user identified by {userName}. The request data may specify a different keyAlias value, in which case the request will update the keyAlias.

Request Entity type: <xs:element name="PublicKey">
Response Entity type: <xs:element name="PublicKey">

addPublicKey_1_1

public javax.ws.rs.core.Response addPublicKey_1_1(@Context
                                                  javax.servlet.http.HttpServletRequest request,
                                                  PublicKey publicKey)

POST /rest/PublicKeys

Add a new public key to the system.

Request Entity type: <xs:element name="PublicKey">
Response Entity type: <xs:element name="PublicKey">

Since:

1.1

addPublicKey

public PublicKey addPublicKey(@Context
                              javax.servlet.http.HttpServletRequest request,
                              PublicKey publicKey)

Deprecated. As of 1.1, replaced by addPublicKey_1_1(HttpServletRequest, PublicKey)

POST /rest/PublicKeys

Add a new public key to the system.

Request Entity type: <xs:element name="PublicKey">
Response Entity type: <xs:element name="PublicKey">