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

Command

files-cli user-requests list

Output

Outputs a list of UserRequest objects according to the output format.

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

files-cli user-requests list

Show User Request

Command

files-cli user-requests find

Output

Outputs a UserRequest object according to the output format.

Authorization Requirement

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

Flags

FlagDescription
--id=
int64
Required		User Request ID.

Example Request

files-cli user-requests find \
  --id=1

Create User Request

Command

files-cli user-requests create

Output

Outputs a UserRequest object according to the output format.

Authorization Requirement

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

Flags

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

files-cli user-requests create \
  --name="name" \
  --email="email" \
  --details="details"

Delete User Request

Command

files-cli user-requests delete

Output

No output is returned.

Authorization Requirement

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

Flags

FlagDescription
--id=
int64
Required		User Request ID.

Example Request

files-cli user-requests delete \
  --id=1

The UserRequest Object

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