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 Function

UserRequest.list()

Return Object

ListIterator<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

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserRequest;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  ListIterator<UserRequest> userRequests = UserRequest.list(parameters);
  for (UserRequest userRequest : userRequests.listAutoPaging()) {
    // Operate on userRequest
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Show User Request

SDK Function

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.

Function Arguments

ArgumentDescription
id
int64
Required		User Request ID.

Example Request

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserRequest;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  UserRequest userRequest = UserRequest.find(id, parameters);
  // Operate on userRequest
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Create User Request

SDK Function

UserRequest.create()

Return Object

UserRequest

Authorization Requirement

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

Function 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

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserRequest;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("name", "name");
  parameters.put("email", "email");
  parameters.put("details", "details");
  
  UserRequest userRequest = UserRequest.create(parameters);
  // Operate on userRequest
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

Delete User Request

SDK Function

userRequest.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

import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserRequest;

try {
  // Find the userRequest object by its id.
  UserRequest userRequest = UserRequest.find(id, null);
  userRequest.delete(null);
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The UserRequest Object

Some of the functions 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