Metadata field access controls¶
In the following reference, {field-access-resource}
is one of the following:
/metadata-field/{field-name}/access
/metadata-field/field-group/{group-name}/access
Managing metadata field access controls¶
Retrieve the access control list of an item¶
-
GET
{field-access-resource}
¶ Returns the access control list that is applied to the specified field or group.
Produces: - application/xml, application/json – MetadataFieldAccessControlListDocument
Role: _administrator
Example¶
GET /metadata-field/title/access
<MetadataFieldAccessControlListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<access>
<id>VX-10</id>
<field>title</field>
<group>mygroup</group>
<permission>READ</permission>
</access>
<access>
<id>VX-5</id>
<field>title</field>
<user>myuser</user>
<permission>DELETE</permission>
</access>
</MetadataFieldAccessControlListDocument>
Add an access control entry¶
-
POST
{field-access-resource}
¶ Creates an entry in the access control list and returns the created entry together with its id.
Accepts: - application/xml, application/json – MetadataFieldAccessControlDocument
Produces: - application/xml, application/json – MetadataFieldAccessControlDocument
Role: _administrator
Examples¶
POST /metadata-field/title/access
Content-Type: application/xml
<MetadataFieldAccessControlDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<user>admin</user>
<permission>DELETE</permission>
</MetadataFieldAccessControlDocument>
<MetadataFieldAccessControlDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<id>VX-11</id>
<user>admin</user>
<permission>DELETE</permission>
</MetadataFieldAccessControlDocument>
Remove an access control entry¶
-
DELETE
{field-access-resource}/
(access-id)¶ Removes the access control entry with the specified id.
Role: _administrator