VMware Cloud Director API - ControlAccessParams

VMware Cloud Director API - ControlAccessParams

ControlAccessParamsType

Element:
ControlAccessParams
Type:
ControlAccessParamsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Specifies access controls for a resource.
Since:
0.9
Schema:
common.xsd
Media type(s):
application/vnd.vmware.vcloud.controlAccess+xml
application/vnd.vmware.vcloud.controlAccess+json
Extends:
VCloudExtensibleType
XML Representation:
<ControlAccessParams xmlns="http://www.vmware.com/vcloud/v1.5">
    <IsSharedToEveryone> xs:boolean </IsSharedToEveryone>
    <EveryoneAccessLevel> xs:string </EveryoneAccessLevel>
    <AccessSettings>
        <AccessSetting>
            <Subject href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <ExternalSubject>
                <SubjectId> xs:string </SubjectId>
                <IsUser> xs:boolean </IsUser>
                <IdpType> xs:string </IdpType>
            </ExternalSubject>
            <AccessLevel> xs:string </AccessLevel>
        </AccessSetting>
    </AccessSettings>
</ControlAccessParams>

Elements

Element Type Required Modifiable Since Deprecated Description
AccessSettings AccessSettingsType No always 0.9 The access settings to be applied if IsSharedToEveryone is false. Required on create and modify if IsSharedToEveryone is false.
EveryoneAccessLevel string No always 0.9 If IsSharedToEveryone is true, this element must be present to specify the access level. for all members of the organization. One of:
FullControl
Change
ReadOnly
IsSharedToEveryone boolean Yes always 0.9 If true, the resource is shared with everyone in the organization. Defaults to false.
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD Operation Description Since Deprecated
create POST /catalog/{catalogId}/action/controlAccess Update access control information for a catalog. 9.0
create POST /org/{id}/catalog/{catalogId}/action/controlAccess Update access control information for a catalog. 0.9 7.0
create POST /vApp/{id}/action/controlAccess Update access control information for a vApp. 0.9
read GET /admin/extension/vdcTemplate/{id}/controlAccess Retrieve access control information for a VDC template. 5.7
read GET /admin/vdcTemplate/{id}/controlAccess Retrieve access control information for a VDC template. 5.7
read GET /catalog/{catalogId}/controlAccess Retrieve access control information for a catalog. 9.0
read GET /org/{id}/catalog/{catalogId}/controlAccess Retrieve access control information for a catalog. 0.9 7.0
read GET /vApp/{id}/controlAccess Retrieve access control information for a vApp. 0.9
read GET /vdc/{id}/controlAccess Retrieve access control information for a VDC.
as input PUT /admin/extension/vdcTemplate/{id}/action/controlAccess Update access control information for a VDC template. 5.7
as input PUT /admin/vdcTemplate/{id}/action/controlAccess Update access control information for a VDC template. 5.7
as input PUT /vdc/{id}/action/controlAccess Update access control information for a VDC.