API Keys

An APIKey is a key that allows programmatic access to your Site.

API keys confer all the permissions of the user who owns them unless the key uses a restricted permission set. If an API key is created without a user owner, it is considered a site-wide API key. Site-wide API keys with the files_only permission set are restricted to file-user permissions and workspace scoping.

We recommend registering API keys to service users wherever possible and then using User or Group Permissions to restrict that API Key appropriately.

List API Keys

SDK Method

Files::ApiKey.list

Return Object

List<ApiKey>

Authorization Requirement

Not available to user API keys or sessions from users that are marked as Shared/Bot users.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

begin
  api_keys = Files::ApiKey.list(
    user_id: 1
  )
  api_keys.auto_paging_each do |api_key|
    # Operate on api_key
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show information about current API key. (Requires current API connection to be using an API key.)

SDK Method

Files::ApiKey.find_current

Return Object

ApiKey

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  api_key = Files::ApiKey.find_current
  # Operate on api_key
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show API Key

SDK Method

Files::ApiKey.find

Return Object

ApiKey

Authorization Requirement

Not available to user API keys or sessions from users that are marked as Shared/Bot users.

Method Arguments

ArgumentDescription
id
int64
Required		Api Key ID.

Example Request

begin
  api_key = Files::ApiKey.find(id)
  # Operate on api_key
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create API Key

SDK Method

Files::ApiKey.create

Return Object

ApiKey

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDefaultDescription
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
name
string
Required		""Internal name for the API Key. For your use.
aws_style_credentials
boolean		falseIf true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
path
string		Folder path restriction for office_integration permission set API keys.
permission_set
string		"full"Permissions for this API Key. 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. Keys with the files_only permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
Possible values: none, full, desktop_app, sync_app, office_integration, mobile_app, files_only
workspace_id
int64		0Workspace ID for this API Key. 0 means the default workspace.

Example Request

begin
  api_key = Files::ApiKey.create(
    name: "My Main API Key"
  )
  # Operate on api_key
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update current API key. (Requires current API connection to be using an API key.)

SDK Method

Files::ApiKey.update_current

Return Object

ApiKey

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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. 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. Keys with the files_only permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
Possible values: none, full, desktop_app, sync_app, office_integration, mobile_app, files_only

Example Request

begin
  api_key = Files::ApiKey.update_current(
    expires_at: "2000-01-01T01:00:00Z"
  )
  # Operate on api_key
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update API Key

SDK Method

api_key.update

Return Object

ApiKey

Authorization Requirement

Not available to user API keys or sessions from users that are marked as Shared/Bot users.

Method Arguments

ArgumentDescription
description
string		User-supplied description of API key.
expires_at
string		API Key expiration date
name
string		Internal name for the API Key. For your use.

Example Request

begin
  # Find the api_key object by its id.
  api_key = Files::ApiKey.find(id)
  api_key.update(
    description: "example"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete current API key. (Requires current API connection to be using an API key.)

SDK Method

Files::ApiKey.delete_current

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  Files::ApiKey.delete_current
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete API Key

SDK Method

api_key.delete

Return Object

nil

Authorization Requirement

Not available to user API keys or sessions from users that are marked as Shared/Bot users.

Example Request

begin
  # Find the api_key object by its id.
  api_key = Files::ApiKey.find(id)
  api_key.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ApiKey Object

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

AttributeDescription
id
int64		API Key ID
descriptive_label
string		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
string		User-supplied description of API key.
created_at
date-time		Time which API Key was created
expires_at
date-time		API Key expiration date
key
string		API Key actual key string
aws_style_credentials
boolean		If true, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
aws_access_key_id
string		AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
aws_secret_key
string		AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
last_use_at
date-time		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
string		Internal name for the API Key. For your use.
permission_set
string		Permissions for this API Key. 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. Keys with the files_only permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
Possible values: none, full, desktop_app, sync_app, office_integration, mobile_app, files_only
platform
string		If this API key represents a Desktop app, what platform was it created on?
site_id
int64		Site ID
site_name
string		Site Name
url
string		URL for API host.
user_id
int64		User ID for the owner of this API Key. May be blank for Site-wide API Keys.
workspace_id
int64		Workspace ID for this API Key. 0 means the default workspace.