Reader Object

Field Overview

Name Type Example Notes
username String john@johndoe.com *Required. If you are using the setting "Allow readers to administer their own passwords" the username field will need to be set to a valid email address. If not, this field can be any unique string.
status String active *Required. Can be one of the following: 'active',  'deleted'.
ssoid String/Mixed 123456789abcde For use with remote authentication and other integrations. A unique remote ID that can be used to identify the reader in our system.
first_name String John
last_name String Doe
icon String //www.url.com/image.jpg To add an icon to a reader through the API, first upload the image to the library using this method and then use the returned URL.
password String 1234abcd For use with admin administered readers only.
projects Array ['559f118932131c6576ccb5be', '559f118932131c6576ccb5bd'] Array of knowledge base IDs that this reader has access to.
reader_roles Array ['559f118932131c6576ccb5be', '559f118932131c6576ccb5bd'] Array of reader group IDs that this reader belongs to.
custom1 String Custom Data 1 Any custom string of your choosing can be stored in this field.
custom2 String Custom Data 2 Any custom string of your choosing can be stored in this field.
custom3 String Custom Data 3 Any custom string of your choosing can be stored in this field.
custom4 String Custom Data 4 Any custom string of your choosing can be stored in this field.
custom5 String Custom Data 5 Any custom string of your choosing can be stored in this field.

Example Response


stdClass Object
(
    [valid] => 1
    [data] => stdClass Object
        (
            [id] => 54947a33fe775a0404000044
            [type] => reader
            [ssoid] => 1234abd
            [username] => john@doe.com
            [first_name] => John
            [last_name] => Doe
            [icon] => //dyzz9obi78pm5.cloudfront.net/app/image/id/56cb79f332131cb536494d6f/n/image.jpg
            [custom1] => custom1
            [custom2] => 
            [custom3] => 
            [custom4] => 
            [custom5] => 
            [password] => 
            [date_lastlogin] => 12/19/2014 2:47 pm EST
            [date_created] => 
            [date_modified] => 02/22/2016 4:13 pm EST
            [status] => active
            [agent] => 
            [projects] => Array (
                    [0] => 539c7527fe775a6f3400000a
                )
            [reader_roles] => 
        )
)