A newer version of this documentation is available.

View Latest

Create a Read-Only Administrator

    Only the Full Administrator can create Read-only Administrators using the POST /settings/readOnlyUser HTTP method and URI.


    To create a read-only user, specify the username and password. Administrative access is required to create a read-only user.

    A username is a UTF-8 string that does not contain spaces, control characters or any of these characters: ()<>@,;:\"/[]?={} characters. Passwords must be UTF-8 with no control characters and must be at least six characters long.

    HTTP Method and URI

    The read-only user is created using the username and password parameters (mandatory). The just_validate=1 parameter validates the username and password for the read-only user.

    POST /settings/readOnlyUser


    • username

    • password

    • just_validate (optional)

    The endpoint has one additional, optional parameter just_validate=1. If the just_validate=1 parameter is specified, the server does not create the user. Instead the username and password for the read-only user is validated.


    Basic syntax:

    POST /settings/readOnlyUser
    	-d username=[username]
    	-d password=[password]

    Curl request syntax:

    curl -X POST -u [admin]:[password]
      -d username=[username]
      -d password=[password]


    Curl request example:

    curl -X POST -u Administrator:password \ \
      -d 'username=a_user' \
      -d 'password=password1'


    If successful, no response displays.


    To verify that you created a read-only, retrieve the user name with GET /settings/readOnlyAdminName HTTP method and URI.