com.quantum.dxi.rest.rbac

Class RbacResourceAccess

java.lang.Object

Base

com.quantum.dxi.rest.rbac.RbacResourceAccess

public class RbacResourceAccess
extends Base

The RbacResourceAccess resource represents access control lists for resources on the system. The RbacResourceAccess service includes interfaces for getting and updating the access control lists.

The schema that defines the RbacResourceAccess resource is defined below.

 
    <xs:complexType name="RbacResourceNameType">
       <xs:sequence>
         <xs:element name="Type" type="xs:string"/>
         <xs:element name="Name" type="xs:string"/>
       </xs:sequence>
   </xs:complexType>
   <xs:element name="RbacResourceNameListScalar" type="RbacResourceNameListScalarType"/>
   <xs:complexType name="RbacResourceNameListScalarType">
       <xs:complexContent>
           <xs:extension base="ScalarType">
               <xs:sequence>
                   <xs:element name="Value" type="RbacResourceNameType" minOccurs="0" maxOccurs="unbounded"/>
               </xs:sequence>
           </xs:extension>
       </xs:complexContent>
   </xs:complexType>
   <xs:element name="RbacAccess">
     <xs:complexType>
       <xs:sequence>
         <xs:element name="ResourceName" type="RbacResourceNameType"/>
         <xs:element name="Groups" type="StringListScalarType" minOccurs="0"/>
       </xs:sequence>
     </xs:complexType>
   </xs:element>
   <xs:element name="RbacResource">
     <xs:complexType>
       <xs:sequence>
         <xs:element name="Name" type="RbacResourceNameType"/>
         <xs:element name="Description" type="xs:string" minOccurs="0"/>
       </xs:sequence>
     </xs:complexType>
   </xs:element>
   <xs:simpleType name="RbacResourceColumnNameType">
       <xs:restriction base="xs:string">
         <xs:enumeration value="Name"/>
         <xs:enumeration value="Description"/>
       </xs:restriction>
   </xs:simpleType>
   <xs:element name="RbacResources">
     <xs:complexType>
       <xs:sequence>
         <xs:element name="TotalCount" type="xs:int" minOccurs="0"/>
         <xs:element ref="RbacResource" minOccurs="0" maxOccurs="unbounded"/>
       </xs:sequence>
     </xs:complexType>
   </xs:element>* 
 

Constructor Summary

Constructors

Constructor and Description
RbacResourceAccess()

Method Summary

Modifier and Type	Method and Description
RbacAccess	addAccess(javax.servlet.http.HttpServletRequest request, java.lang.String type, java.lang.String name, RbacAccess rbacAccess) PUT /RbacResourceAccess/{type}/{name}/addGroups
RbacAccess	deleteAccess(javax.servlet.http.HttpServletRequest request, java.lang.String type, java.lang.String name, RbacAccess rbacAccess) PUT /RbacResourceAccess/{type}/{name}/deleteGroups
RbacResources	getResources(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /RbacResourceAccess
RbacAccess	getResources(javax.servlet.http.HttpServletRequest request, java.lang.String type, java.lang.String name) GET /RbacResourceAccess/{type}/{name}
RbacAccess	updateAccess(javax.servlet.http.HttpServletRequest request, java.lang.String type, java.lang.String name, RbacAccess rbacAccess) PUT /RbacResourceAccess/{type}/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

RbacResourceAccess

public RbacResourceAccess()

Method Detail

getResources

public RbacResources getResources(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  int start,
                                  int limit,
                                  java.lang.String sortColumn,
                                  java.lang.String sortDirection,
                                  java.lang.String filterString)

GET /RbacResourceAccess

Get the list of role base access control resources on the system.

The method supports the table query parameters. Column names for sorting and filtering are defined in <xs:simpleType name="RbacResourceColumnNameType">

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

Since:

1.2.2

getResources

public RbacAccess getResources(@Context
                               javax.servlet.http.HttpServletRequest request,
                               java.lang.String type,
                               java.lang.String name)

GET /RbacResourceAccess/{type}/{name}

Get the access list of a resource on the system.

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

Since:

1.2.2

updateAccess

public RbacAccess updateAccess(@Context
                               javax.servlet.http.HttpServletRequest request,
                               java.lang.String type,
                               java.lang.String name,
                               RbacAccess rbacAccess)

PUT /RbacResourceAccess/{type}/{name}

Replaces group names in a resource access control list. To delete all groups, use PUT /RbacResourceAccess/{type}/{name}/deleteGroups.

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

Since:

1.2.2

addAccess

public RbacAccess addAccess(@Context
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String type,
                            java.lang.String name,
                            RbacAccess rbacAccess)

PUT /RbacResourceAccess/{type}/{name}/addGroups

Adds group names to a resource access control list.

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

Since:

1.2.2

deleteAccess

public RbacAccess deleteAccess(@Context
                               javax.servlet.http.HttpServletRequest request,
                               java.lang.String type,
                               java.lang.String name,
                               RbacAccess rbacAccess)

PUT /RbacResourceAccess/{type}/{name}/deleteGroups

Deletes group names from a resource access control list.

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

Since:

1.2.2