com.files.models

Class ApiKey

java.lang.Object

com.files.models.ApiKey

All Implemented Interfaces:

ModelInterface

public class ApiKey
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Date	createdAt Time which API Key was created
String	description User-supplied description of API key.
String	descriptiveLabel Unique label that describes this API key.
Date	expiresAt API Key expiration date
Long	id API Key ID
String	key API Key actual key string
Date	lastUseAt API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
String	name Internal name for the API Key.
String	path Folder path restriction for `office_integration` permission set API keys.
String	permissionSet Permissions for this API Key.
String	platform If this API key represents a Desktop app, what platform was it created on?
String	url URL for API host.
Long	userId User ID for the owner of this API Key.

Constructor Summary

Constructors

Constructor and Description
ApiKey()
ApiKey(HashMap<String,Object> parameters)
ApiKey(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<ApiKey>	all()
static ListIterator<ApiKey>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - User ID.
static ApiKey	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	deleteCurrent(HashMap<String,Object> parameters)
static void	deleteCurrent(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Api Key ID.
static ApiKey	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	findCurrent(HashMap<String,Object> parameters)
static ApiKey	findCurrent(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	get()
static ApiKey	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<ApiKey>	list() Parameters: user_id - int64 - User ID.
static ListIterator<ApiKey>	list(HashMap<String,Object> parameters)
static ListIterator<ApiKey>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
ApiKey	update() Parameters: description - string - User-supplied description of API key.
static ApiKey	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	update(Long id, HashMap<String,Object> parameters) Parameters: description - string - User-supplied description of API key.
static ApiKey	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ApiKey	updateCurrent(HashMap<String,Object> parameters) Parameters: expires_at - string - API Key expiration date name - string - Internal name for the API Key.
static ApiKey	updateCurrent(HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

id

public Long id

API Key ID

descriptiveLabel

public String descriptiveLabel

Unique label that describes this API key. Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.

description

public String description

User-supplied description of API key.

createdAt

public Date createdAt

Time which API Key was created

expiresAt

public Date expiresAt

API Key expiration date

key

public String key

API Key actual key string

lastUseAt

public Date lastUseAt

API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.

name

public String name

Internal name for the API Key. For your use.

permissionSet

public String permissionSet

Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

platform

public String platform

If this API key represents a Desktop app, what platform was it created on?

url

public String url

URL for API host.

userId

public Long userId

User ID for the owner of this API Key. May be blank for Site-wide API Keys.

path

public String path

Folder path restriction for `office_integration` permission set API keys.

Constructor Detail

ApiKey

public ApiKey()

ApiKey

public ApiKey(HashMap<String,Object> parameters)

ApiKey

public ApiKey(HashMap<String,Object> parameters,
              HashMap<String,Object> options)

Method Detail

update

public ApiKey update()
              throws IOException

Parameters: description - string - User-supplied description of API key. expires_at - string - API Key expiration date permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know. name - string - Internal name for the API Key. For your use.

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<ApiKey> list()
                                 throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.

Throws:

RuntimeException

list

public static ListIterator<ApiKey> list(HashMap<String,Object> parameters)
                                 throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<ApiKey> list(HashMap<String,Object> parameters,
                                        HashMap<String,Object> options)
                                 throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<ApiKey> all()
                                throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<ApiKey> all(HashMap<String,Object> parameters,
                                       HashMap<String,Object> options)
                                throws RuntimeException

Throws:

RuntimeException

findCurrent

public static ApiKey findCurrent(HashMap<String,Object> parameters)
                          throws RuntimeException

Throws:

RuntimeException

findCurrent

public static ApiKey findCurrent(HashMap<String,Object> parameters,
                                 HashMap<String,Object> options)
                          throws RuntimeException

Throws:

RuntimeException

find

public static ApiKey find(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Parameters: id (required) - int64 - Api Key ID.

Throws:

RuntimeException

find

public static ApiKey find(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

find

public static ApiKey find(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

get

public static ApiKey get()
                  throws RuntimeException

Throws:

RuntimeException

get

public static ApiKey get(Long id,
                         HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

create

public static ApiKey create(HashMap<String,Object> parameters)
                     throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. description - string - User-supplied description of API key. expires_at - string - API Key expiration date permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know. name (required) - string - Internal name for the API Key. For your use. path - string - Folder path restriction for `office_integration` permission set API keys.

Throws:

RuntimeException

create

public static ApiKey create(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

updateCurrent

public static ApiKey updateCurrent(HashMap<String,Object> parameters)
                            throws RuntimeException

Parameters: expires_at - string - API Key expiration date name - string - Internal name for the API Key. For your use. permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.

Throws:

RuntimeException

updateCurrent

public static ApiKey updateCurrent(HashMap<String,Object> parameters,
                                   HashMap<String,Object> options)
                            throws RuntimeException

Throws:

RuntimeException

update

public static ApiKey update(Long id,
                            HashMap<String,Object> parameters)
                     throws RuntimeException

Parameters: description - string - User-supplied description of API key. expires_at - string - API Key expiration date permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know. name - string - Internal name for the API Key. For your use.

Throws:

RuntimeException

update

public static ApiKey update(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

update

public static ApiKey update(Long id,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

deleteCurrent

public static void deleteCurrent(HashMap<String,Object> parameters)
                          throws RuntimeException

Throws:

RuntimeException

deleteCurrent

public static void deleteCurrent(HashMap<String,Object> parameters,
                                 HashMap<String,Object> options)
                          throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException