access Data Type

The access a user or group has to a resource.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
role string element 0/1 Allowed values are NONE, VIEWER, EDITOR, CONTRIBUTOR and ACCESS. Not all values are allowed in every context where Access objects are used.
sharing sharingPermission element 0/1 The sharing permissions assigned to the user or group.
Properties inherited from baseRestObject
href string element 0/1 The path to this resource object. This is relative to the root of the REST API (https://serveraddress/rest).
link link element 0/unbounded Links to related resources. These should be used to navigate the REST API (instead of hard-coding the URLs)

Example

<access>
  <role>...</role>
  <sharing>
    <external>...</external>
    <internal>...</internal>
    <all_internal>...</all_internal>
    <all_external>...</all_external>
    <public>...</public>
    <public_link>...</public_link>
    <grant_reshare>...</grant_reshare>
  </sharing>
  <href>...</href>
  <links>
    <link>
      <href>...</href>
      <rel>...</rel>
    </link>
  </links>
</access>