Developing with Lytics / Lytics API Documentation

Account Settings

Account Settings describe features/settings for a Lytics account.

Account Setting

/api/account/setting/{setting}

Account Setting Api.

Parameters
settingstring (required)
Ex: enforce_password_history
slug of account setting.
GET

Retrieve a Single Account Setting

/api/account/setting/{setting}

Get single Account Setting by slug.

Response 200

Headers
Content-Type: application/json
Body
    {
        "can_be_assigned": true,
        "category": "Security",
        "field": {
            "description": "Enforce rule preventing re-use of same password.",
            "editable": false,
            "label": "",
            "name": "Enforce Password History",
            "optional": false,
            "sort_order": 0,
            "type": "boolean",
            "user_config_disabled": false
        },
        "slug": "enforce_password_history",
        "type": "setting",
        "value": null
    }
PUT

Account Setting Update

/api/account/setting/{setting}

Post update to Account Setting. See list of possible Settings from the List api.

curl -XPUT "https://api.lytics.io/api/account/setting/logon_session_days" \
   -H 'Content-type: application/json' \
   -H "Authorization: $LIOKEY" \
   -d '10'

Request

Headers
Content-Type: application/json
Body
10

Response 200

Headers
Content-Type: application/json
Body
    {
        "can_be_assigned": true,
        "category": "Security",
        "field": {
            "description": "Enforce rule preventing re-use of same password.",
            "editable": false,
            "label": "",
            "name": "Enforce Password History",
            "optional": false,
            "sort_order": 0,
            "type": "boolean",
            "user_config_disabled": false
        },
        "slug": "enforce_password_history",
        "type": "setting",
        "value": null
    }
DELETE

Account Setting Delete

/api/account/setting/{setting}

Delete a custom account setting. Given a key for a setting, delete the custom-value.

Note, since account-settings may have default values, this only deletes the entire value that currently exists.

curl -XDELETE "https://api.lytics.io/api/account/setting/logon_session_days" \
   -H "Authorization: $LIOKEY"

Request

Headers
Authorization: {API Token}

Response 204

Account Setting List

/api/account/setting

Collection of all Account Settings.

This api serves as documentation for the Settings as well.

curl -s "https://api.lytics.io/api/account/setting" \
   -H 'Content-type: application/json' \
   -H "Authorization: $LIOKEY"
GET

Account Setting List

/api/account/setting

Response 200

Headers
Content-Type: application/json
Body
{
    "status": "success",
    "data": [
                {
                    "can_be_assigned": true,
                    "category": "Security",
                    "field": {
                        "description": "Enforce rule preventing re-use of same password.",
                        "editable": false,
                        "label": "",
                        "name": "Enforce Password History",
                        "optional": false,
                        "sort_order": 0,
                        "type": "boolean",
                        "user_config_disabled": false
                    },
                    "slug": "enforce_password_history",
                    "type": "setting",
                    "value": null
                },
                {
                    "can_be_assigned": true,
                    "category": "Security",
                    "field": {
                        "description": "Enforce rule forcing high-password complexity.",
                        "editable": false,
                        "label": "",
                        "name": "Enforce Password Complexity",
                        "optional": false,
                        "sort_order": 0,
                        "type": "boolean",
                        "user_config_disabled": false
                    },
                    "slug": "enforce_password_complexity",
                    "type": "setting",
                    "value": null
                },
                {
                    "can_be_assigned": true,
                    "category": "Security",
                    "field": {
                        "description": "Ensure all users have two-factor auth.",
                        "editable": false,
                        "label": "",
                        "name": "All users must have two factor auth.",
                        "optional": false,
                        "sort_order": 0,
                        "type": "boolean",
                        "user_config_disabled": false
                    },
                    "slug": "enforce_two_factor_auth",
                    "type": "setting",
                    "value": null
                }
    ]
}