User Requests

A UserRequest is an operation that allows anonymous users to place a request for access on the login screen to the site administrator.

List User Requests

SDK Method

\Files\Model\UserRequest::list;

Return Object

UserRequest[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

try {
  $user_requests = \Files\Model\UserRequest::list();
  foreach ($user_requests as $user_request) {
    // Operate on $user_request
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show User Request

SDK Method

\Files\Model\UserRequest::find;

Return Object

UserRequest

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		User Request ID.

Example Request

try {
  $user_request = \Files\Model\UserRequest::find($id);
  // Operate on $user_request
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create User Request

SDK Method

\Files\Model\UserRequest::create;

Return Object

UserRequest

Authorization Requirement

No authentication required; you may call this endpoint without a key or session.

Method Arguments

ArgumentDescription
name
string
Required		Name of user requested
email
string
Required		Email of user requested
details
string
Required		Details of the user request
company
string		Company of the user requested

Example Request

try {
  $user_request = \Files\Model\UserRequest::create([
    'name' => "name",
    'email' => "email",
    'details' => "details"
  ]);
  // Operate on $user_request
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete User Request

SDK Method

$user_request->delete;

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

try {
  // Find the user_request object by its id.
  $user_request = \Files\Model\UserRequest::find(id);
  $user_request->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The UserRequest Object

Some of the methods above return a UserRequest object. The attributes of this object are listed below.

AttributeDescription
id
int64		ID
name
string		User's full name
email
email		User email address
details
string		Details of the user's request
company
string		User's company name