Nomadesk API

Controller: Vault Management: GetPermissions

GetPermissions

This API method is accessable when using an email&password token

Authentication Methods


  • With a username and password
Input Parameter Type Description
Token* String Security token
FileserverName* String FileServer name
Path String optional path
Email EmailAddress Optional email address(account) to get the access for
Output Parameter Type Description
Permissions String Permissions the user has on a Vault or Path

*=required

EXAMPLES

curl 'https://secure.nomadesk.com/ctrller/api.php?Token=rrc1d3ntb53tt6b2vhail6rdtrsxov3v&Task=GetPermissions&FileserverName=nmsa000010&Path=/directory'

RESPONSE

<Response>
    <Status>1</Status>
    <Message>Success</Message>
    <Permissions>

        <Permission>
            <Name>nmua000000000001</Name>
            <FirstName>user</FirstName>
            <LastName>01</LastName>
            <Email>user01@example.com</Email>
            <Status>Guest</Status>
            <Path></Path>
            <Access>ReadWrite</Access>
            <AllowInvite>true</AllowInvite>
            <AllowFolderLink>true</AllowFolderLink>
            <AllowWidget>true</AllowWidget>
            <AllowTransferOwner>false</AllowTransferOwner>
            <AllowChangeSettings>false</AllowChangeSettings>
            <AllowEmail2Folder>true</AllowEmail2Folder>
        </Permission>

        <Permission>
            <FirstName>user</FirstName>
            <LastName>02</LastName>
            <Email>user02@example.com</Email>
            <Status>Guest</Status>
            <Path>/directory</Path>
            <Access>ReadWrite</Access>
            <AllowInvite>true</AllowInvite>
            <AllowFolderLink>true</AllowFolderLink>
            <AllowWidget>true</AllowWidget>
            <AllowTransferOwner>false</AllowTransferOwner>
            <AllowChangeSettings>false</AllowChangeSettings>
            <AllowEmail2Folder>true</AllowEmail2Folder>
        </Permission>

        <Permission>
            <FirstName>user</FirstName>
            <LastName>03</LastName>
            <Email>user03@example.com</Email>
            <Status>Guest</Status>
            <Path>/directory/subdirectory</Path>
            <Access>ReadWrite</Access>
            <AllowInvite>true</AllowInvite>
            <AllowFolderLink>true</AllowFolderLink>
            <AllowWidget>true</AllowWidget>
            <AllowTransferOwner>false</AllowTransferOwner>
            <AllowChangeSettings>false</AllowChangeSettings>
            <AllowEmail2Folder>true</AllowEmail2Folder>
        </Permission>

        <Permission>
            <FirstName>admin</FirstName>
            <LastName>admin</LastName>
            <Email>admin@example.com</Email>
            <Status>Admin</Status>
            <Path></Path>
            <Access>ReadWrite</Access>
            <AllowInvite>true</AllowInvite>
            <AllowFolderLink>true</AllowFolderLink>
            <AllowWidget>true</AllowWidget>
            <AllowTransferOwner>true</AllowTransferOwner>
            <AllowChangeSettings>true</AllowChangeSettings>
            <AllowEmail2Folder>true</AllowEmail2Folder>
        </Permission>
    </Permissions>
</Response>