‘user_data’

/api/v1/users/{user_id}/data/{data_id}*record_id

Access to data of the user.

Requires logged_session_id of user or admin.

Data is defined for events. You may access data only of the event you are logged in.

Data permissions

1. Restricted records - admin and user can read, but only admin can write (restricted write)
2. Sensitive records - admin and user can write, but only user can read (restricted read)

GET

Read data. Data consists of records. You may read all records or specific one. Add login_session_id as query-string parameter.

Read all records of OSLogon data:

GET /api/v1/users/1234/data/OSLogon

Read record password of OSLogon data:

GET /api/v1/users/1234/data/OSLogon/password

Returns:

{ 'data': {'password': 'value'} }

DELETE

Delete all records of OSLogon data:

DELETE /api/v1/users/1234/data/OSLogon

Delete password record only:

DELETE /api/v1/users/1234/data/OSLogon/password

PATCH

Modify data.

Create/modify record field1 for OSLogon data:

PATCH /api/v1/users/1234/data/OSLogon
{
    'data': { 'field1': 'a value'}
}

Modify record field1 and remove record field2 and create field3 for OSLogon data:

PATCH /api/v1/users/1234/data/OSLogon
{
    'data':
    {
        'field1': 'new_value',
        'field2': None,
        'field3':
        {
            'inner': 'dict',
            'is':
            {
                'possible': 'at',
                'any': 'level'
            }
        }
    }
}

Modifications/additions are recursive and process sub-records:

PATCH /api/v1/users/1234/data/OSLogon
{
    'data':
    {
        'field3': { 'sub-record': 'is added' }
    }
}

# will add sub-record in 'field3' as follows:

data['field3'] == {
        'inner': 'dict',
        'is':
        {
            'possible': 'at',
            'any': 'level',
            'sub-record': 'is added'
        }
}