Common Organization Data¶
In order to simplify the organization management process, the response from the following endpoints always returns an organization object in JSON form:
- GET /v3/organizations/<org_id>
- PUT /v3/organizations/<org_id>
The following table describes the editable fields in the organization object:
| Field | Type | Description |
|---|---|---|
| support_email | String | For more information, see Modify the Support Email Address. |
| email_from_name | String | Set the name that appears in the From field for automatic email notifications. |
| email_from_address | String | Set the email address that appears in the From field for automatic email notifications. |
| email_reply_to_address | String | Set the email address used for replying to automatic email notifications. |
| invite_template_for_user | String | For more information, see Customizing Email Messages. |
| invite_subject_for_user | String | For more information, see Customizing Email Messages. |
| invite_template_for_affiliated | String | For more information, see Customizing Email Messages. |
| invite_subject_for_affiliated | String | For more information, see Customizing Email Messages. |
| session_timeout_in_minutes | Integer | Set the number of minutes a user stays logged into the App Catalog if they don’t choose Remember Me at login. 10 minutes by default. |
| remember_me_timeout_in_minutes | Integer | Set the number of minutes a user stays logged into the App Catalog if they do choose Remember Me at login. 1 week by default. |
| no_auth_app_delivery_enabled | Boolean | Enable or disable Direct Install for the entire organization (which overwrites the setting on individual apps). For more information, see Delivering Applications via Direct Install URL. |
| password_complexity | Object | Set password requirements for the organization. For more information, see Set Password Requirements. |
| application_custom_metadata_template | Object | Submit a custom app metadata template. For more information, see Define a Custom Metadata Template. |
| user_custom_metadata_template | Object | Submit a custom user metadata template. For more information, see Define a Custom Metadata Template. |
| banner_image_enabled | Boolean | Enable or disable the ability to add a banner image for App Catalogs. |
| no_auth_policies_enabled | Boolean | Enable or disable No-Registration policies. For more information, see Enable No Registration Policies. |
| cors_domain_whitelist | List of Strings | Configure a domain whitelist for custom admin sites. For more information, see Set Password Requirements. |
| reviews_default_value | Boolean | Set the value that appears by default when reviews are enabled. |
| kryptowire_settings | Object | Set the Kryptowire API Key. For more information, see Set the Kryptowire API Key. |
| notify_on_device_registration | Boolean | Enable or disable notifications when devices are registered. For more information, see Enable Device Registration Notification. |
| policies_frequency_evaluation_in_hours | Integer | For more information, see Set the Policy Evaluation Frequency. |
Organization Object Integer Descriptions¶
The organization object include some data fields with integer values that aren’t obvious unless you know the corresponding description.
The following tables identify these values:
Authorization Method
Field name: auth_type
| Value | Description |
|---|---|
| 0 | Normal Apperian login with username and password. |
| 1 | SSO login, which redirects to the user’s SSO login page. |
| 2 | SSO login, which uses HTTP-Auth. |
Organization Object Example¶
The following example illustrates a typical response from PUT /v3/organizations/<org_id> after sending a request to update an organization.
{
"warnings": [],
"organization": {
"id":"4GeRjtGhiw6kx1jNx4QdNA",
"parent_id":"a82BexNA0D82j5vZj4OW",
"admin_branded":false,
"app_installation_path":"Enterprise Apps",
"apple_push_cert":true,
"auth_type":0,
"banner_image_enabled":false,
"email_from_address":"apperian@arxan.com",
"email_from_name":"The Apperian System",
"email_reply_to_address":"apperian@arxan.com",
"invite_subject_for_affiliated":"Apperian Affiliated Administrator",
"invite_subject_for_user":"Welcome to Apperian",
"invite_template_for_affiliated":"{...}",
"invite_template_for_user":"Welcome to Apperian",
"javascript_protection_policy_enabled":false,
"kryptowire_settings":null,
"name":"Arxan Technologies",
"no_auth_app_delivery_enabled":true,
"no_auth_policies_enabled":false,
"policies_frequency_evaluation_in_hours":0,
"remember_me_timeout_in_minutes":10080,
"reviews_default_value":true,
"session_timeout_in_minutes":10,
"support_email":"support@arxan.com",
"vanity_subdomain":"arxan",
"cors_domain_whitelist":[
"http://arxan.com"
],
"auth_settings":{
"touch_id_auth":{
"enable_touch_id":true
}
},
"password_complexity":{
"password_complexity_for_admins":{
"account_lockout_threshold":0,
"min_length":5,
"min_lowercase":0,
"min_number":0,
"min_symbol":0,
"min_uppercase":0,
"password_expiration_in_minutes":0,
"password_history":1,
"password_reset_interval_time_in_minutes":0
},
"password_complexity_for_users":{
"account_lockout_threshold":0,
"min_length":5,
"min_lowercase":0,
"min_number":0,
"min_symbol":0,
"min_uppercase":0,
"password_expiration_in_minutes":0,
"password_history":1,
"password_reset_interval_time_in_minutes":0
}
},
"user_custom_metadata_template":{
"cities_users":{
"default":"1",
"label":"Cities:",
"options":[
{
"label":"Boston",
"value":"0"
},
{
"label":"London",
"value":"2"
},
{
"label":"Valladolid",
"value":"1"
}
],
"type":"select"
},
"description":{
"default":"default value",
"label":"Description: ",
"type":"textarea"
},
"enabled":{
"default":true,
"label":"Enabled by default? ",
"type":"checkbox"
},
"name":{
"default":"default value",
"label":"Name: ",
"type":"text"
},
"password":{
"default":"default value",
"label":"Password: ",
"type":"password"
},
"restaurants":{
"default":"0,2",
"label":"Restaurants:",
"options":[
{
"label":"Restaurant A",
"value":"0"
},
{
"label":"Restaurant B",
"value":"1"
},
{
"label":"Restaurant C",
"value":"2"
}
],
"type":"multiselect"
}
},
"application_custom_metadata_template":{
"cities_applications":{
"default":"1",
"label":"Cities:",
"options":[
{
"label":"Boston",
"value":"0"
},
{
"label":"London",
"value":"2"
},
{
"label":"Valladolid",
"value":"1"
}
],
"type":"select"
},
"description":{
"default":"default value",
"label":"Description: ",
"type":"textarea"
},
"enabled":{
"default":true,
"label":"Enabled by default? ",
"type":"checkbox"
},
"name":{
"default":"default value",
"label":"Name: ",
"type":"text"
},
"password":{
"default":"default value",
"label":"Password: ",
"type":"password"
},
"restaurants":{
"default":"0,2",
"label":"Restaurants:",
"options":[
{
"label":"Restaurant A",
"value":"0"
},
{
"label":"Restaurant B",
"value":"1"
},
{
"label":"Restaurant C",
"value":"2"
}
],
"type":"multiselect"
}
}
}
}