LDAP

Get LDAP Configurations

GET/api/v1/data/ldap_configs
Authorization: Basic
Response Format: JSON

Response



Get Specific LDAP Configurations

GET/api/v1/data/ldap_configs/:id
Authorization: Basic
Response Format: JSON

Response



Create LDAP Configuration

POST/api/v1/data/ldap_configs
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • directory_type (required:active_directory|open_directory|fedora_directory_server|open_ldap)
  • name (required)
  • description
  • host (required)
  • port
  • base_dn
  • authentication_method (required)
  • username (required)
  • password (required)
  • encryption (required:simple_tls|''; empty string for unencrypted)

Response



Update LDAP Configuration

PUT/api/v1/data/ldap_configs/:id
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • name
  • description
  • host
  • port
  • base_dn
  • authentication_method
  • username
  • password
  • encryption

Response



Delete LDAP Configuration

DELETE/api/v1/data/ldap_configs/:id
Authorization: Basic
Response Format: JSON

SMTP

Get SMTP Configuration

NOTE: There can only be one SMTP configuration

GET/api/v1/data/smtp_server
Authorization: Basic
Response Format: JSON

Response



Create SMTP Configuration

POST/api/v1/data/smtp_server
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • server (required)
  • port (required)
  • domain (required)
  • tls
  • username
  • password
  • from

Response



Update SMTP Configuration

PUT/api/v1/data/smtp_server
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameters

  • server
  • port
  • domain
  • tls
  • username
  • password
  • from

Response



Global Transfer Settings

*Managers can only view global transfer settings

Get Global Transfer Settings

GET/api/v1/data/transfer_settings
Authorization: Basic
Response Format: JSON

Response



Update Global Transfer Settings

PUT/api/v1/data/transfer_settings
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • min_connect_version (Ex. Of the form "X.Y", like 1, 1.2, 1.2.3, or 1.2.3.4)
  • upload_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • upload_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • starting_policy* ("" , fixed, high, fair, low)
  • allowed_policy* ("", "fixed, high, fair, and low", "high, fair, and low", "fair and low", "low" )
  • encryption* ("", Optional, AES-128)
  • encryption_at_rest* ("", Optional, Required)
  • reset_all_defaults (boolean)

* Blank strings indicates inherit setting

Response



User Transfer Settings

Get Specific User's Transfer Settings

GET/api/v1/data/users/:user_id/transfer_settings
Authorization: Basic
Response Format: JSON

* Will result in a 404 if the user doesn't have specific settings set (aka inherits global transfer settings)

Response



Update Specific User's Transfer Settings

PUT/api/v1/data/users/:user_id/transfer_settings
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • upload_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • upload_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • starting_policy* ("" , fixed, high, fair, low)
  • allowed_policy* ("", "fixed, high, fair, and low", "high, fair, and low", "fair and low", "low" )
  • encryption* ("", Optional, AES-128)
  • encryption_at_rest* ("", Optional, Required)

* Blank strings indicates inherit setting

Response



Delete Specific User's Transfer Settings

*This will still return 204 even if there isn't specific transfer settings to delete (because the transfer setting "exists" from the inherited settings)

DELETE/api/v1/data/users/:user_id/transfer_settings
Authorization: Basic
Response Format: JSON

Groups Transfer Settings

Get Specific Group's Transfer Settings

GET/api/v1/data/groups/:group_id/transfer_settings
Authorization: Basic
Response Format: JSON

* Will result in a 404 if the group doesn't have specific settings set (aka inherits global transfer settings)

Response



Update Specific Group's Transfer Settings

PUT/api/v1/data/groups/:group_id/transfer_settings
Authorization: Basic
Response Format: JSON
Request Parameter: JSON

Request Parameter

  • upload_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • upload_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • download_target_rate_cap (Ex: 1.5 Gbps, 500Mbps, 10 K, 3000)
  • starting_policy* ("" , fixed, high, fair, low)
  • allowed_policy* ("", "fixed, high, fair, and low", "high, fair, and low", "fair and low", "low" )
  • encryption* ("", Optional, AES-128)
  • encryption_at_rest* ("", Optional, Required)

* Blank strings indicates inherit setting

Response





Delete Specific Group's Transfer Settings

*This will still return 204 even if there isn't specific transfer settings to delete (because the transfer setting "exists" from the inherited settings)

DELETE/api/v1/data/groups/:group_id/transfer_settings
Authorization: Basic
Response Format: JSON

Video player

Video

×