RequestAccess

Checks if the given Account has access on the given Fileserver for a certain Location.

When the Location does not exist, it is created.

The LastAccessByAccountID field is updated when the RequestAccess was successful.

If the IPAddress and ClientVersion are sent, Location is updated with the passed values.

Authentication Methods


  • ApiKey
Input Parameter Type Description
Token* String Security token
UserName* String Account name(nmua)
FileserverName* String Workspace name(nmsa)
LocationID* String LocationID
ClientVersion* String Version Number of the Client (only required for the Client)
Password* String Password for that user
StorageNode* String The hostname of the StorageNode that makes this request
IPAddress String IPAddress of the Client (only required for the Client)

Output Parameter | Type | Description
---| ---| ---
AccessType | AccessType | Returns, None, ReadOnly or ReadWrite
*=required

Token => EmailPassword and AccessToken authentication
UserNamePassword Authentication => ClientVersion, Password, Location, Workspace, IPAddress

EXAMPLES

curl 'https://example.com/ctller/api.php?Task=RequestAccess&Username=nmua000007&Password=password&ClientVersion=4.0.0.0&LocationID=8891ed2a-8767-d9c6-c641-97557cb7886a&FileserverName=nmsa000008&IPAddress=192.168.0.1' 

RESPONSE

Logged in as a user

<Response>
    <Status>1</Status>
    <Message></Message>
    <AccountName>nmua000001</AccountName>
    <AccessType>ReadWrite</AccessType>
</Response>

Logged in as a partner

<Response>
    <Status>1</Status>
    <Message></Message>
    <AccountName>nmua000001</AccountName>
    <AccessToken>8891ed2a-8767-d9c6-c641-97557cb7886a</AccessToken>
    <Path>/</Path>
    <AllowSubDirectories>true</AllowSubDirectories>
    <AccessType>ReadOnly</AccessType>
</Response>

Logged in as an AMS account

<Response>
    <Status>1</Status>
    <Message></Message>
    <AMS>
        <Username>accountmanagement</Username>
    </AMS>
    <AccessType>None</AccessType>
</Response>    

Logged in with an access token

<Response>
    <Status>1</Status>
    <Message></Message>
    <AccountName>nmua000001</AccountName>
    <AccessType>None</AccessType>
</Response>