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

user_request.List()

Return Values

Returns a *user_request.Iter and an error. Range over All() to receive files_sdk.UserRequest values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_request "github.com/Files-com/files-sdk-go/v3/userrequest"
)

userRequestIterator, err := user_request.List(files_sdk.UserRequestListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for userRequest, err := range userRequestIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(userRequest)
}

Show User Request

SDK Method

user_request.Find()

Return Values

Returns a files_sdk.UserRequest value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

UserRequestFindParams Fields

FieldDescription
Id
int64
Required		User Request ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_request "github.com/Files-com/files-sdk-go/v3/userrequest"
)

userRequest, err := user_request.Find(files_sdk.UserRequestFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userRequest)

Create User Request

SDK Method

user_request.Create()

Return Values

Returns a files_sdk.UserRequest value and an error.

Authorization Requirement

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

UserRequestCreateParams Fields

FieldDescription
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 (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_request "github.com/Files-com/files-sdk-go/v3/userrequest"
)

userRequest, err := user_request.Create(files_sdk.UserRequestCreateParams{
  Name: "name",
  Email: "email",
  Details: "details",
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userRequest)

Delete User Request

SDK Method

user_request.Delete()

Return Values

Returns an error, or nil on success.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

UserRequestDeleteParams Fields

FieldDescription
Id
int64
Required		User Request ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_request "github.com/Files-com/files-sdk-go/v3/userrequest"
)

err := user_request.Delete(files_sdk.UserRequestDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

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