IBM Aspera Faspex 4.4.1 PL6 API Reference
This is a short spec for using the Faspex API to create new users.
Version: v4
Paths
POST /users
Request Content-Types: application/json
Request Example
{
"account_activated": "boolean",
"account_expires": "boolean",
"admin": "boolean",
"can_send_to_all_faspex_users": "boolean",
"can_send_to_external_email": "boolean",
"delete_packages_after_download": "boolean",
"description": "string",
"downloads_allowed": "boolean",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"uploads_allowed": "boolean",
"user_profile_data_attributes": [
{
"user_profile_field_id": "integer",
"value": "string"
}
]
}
200 OK
Success
401 Unauthorized
Invalid credentials
422 Unprocessable Entity
Bad request
Response Content-Types: application/json
Response Example (200 OK)
{
"account_activated": "boolean",
"account_expires": "boolean",
"admin": "boolean",
"can_send_to_all_faspex_users": "boolean",
"can_send_to_external_email": "boolean",
"delete_packages_after_download": "boolean",
"description": "string",
"downloads_allowed": "boolean",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"uploads_allowed": "boolean",
"user_profile_data_attributes": [
{
"user_profile_field_id": "integer",
"value": "string"
}
]
}
Schema Definitions
User:
- account_activated: boolean
-
If true, the account is active.
- account_expires: boolean
-
If true, the account has expired.
- admin: boolean
-
If true, the account is an admin account.
- can_send_to_all_faspex_users: boolean
-
If true, the user can send packages to all other Faspex users.
- can_send_to_external_email: boolean
-
If true, the user can send packages to external emails.
- delete_packages_after_download: boolean
-
If true, the user can set Faspex to delete packages after users have downloaded the sent package.
- description: string
- downloads_allowed: boolean
-
If true, the user can download packages from Faspex.
- email: string
-
The user's email address.
- first_name: string
-
The user's first name.
- last_name: string
-
The user's last name.
- name: string
-
The Faspex user name.
- uploads_allowed: boolean
-
If true, the user can upload files to Faspex.
- user_profile_data_attributes: object[]
-
Set values for custom fields configured in Faspex.
-
object - user_profile_field_id: integer
- value: string
Example
{
"account_activated": "boolean",
"account_expires": "boolean",
"admin": "boolean",
"can_send_to_all_faspex_users": "boolean",
"can_send_to_external_email": "boolean",
"delete_packages_after_download": "boolean",
"description": "string",
"downloads_allowed": "boolean",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"uploads_allowed": "boolean",
"user_profile_data_attributes": [
{
"user_profile_field_id": "integer",
"value": "string"
}
]
}