ctiUser

Last Updated : May 30, 2019 |
This API will create, view, or edit ctiUsers.
Prolog information
Syntax
ctiUser add [userid] [common-name] [surname] [password] [isCtiUser] -ar [avayaRole]
ctiUser modify [userid] -n [common-name] -s [surname] -pw [password] -c [isCtiUser] -ar [avayaRole]
ctiUser delete [userid]
ctiUser view [userid]
ctiUser unrestricted [userid] [true|false]
For example, ctiUser modify user01 -n aesuser -s aes -c no
where:
Argument
Description
isCtiUser
Can have
  • values.
  • avayaRole
    Can have
  • , or
  • add
    Adds user with given parameters.
    modify
    Modify the user with given userid.
    delete
    Delete the user with given userid.
    view
    Views information of the user with given userid.
    unrestricted
    Grants and rejects unrestricted access to a user, if it is a ctiUser
    While viewing CTI user, if userid is not provided, list of all users are displayed.
    The unrestricted option will enable or disable unrestricted SDB access for a given CTI user.
    Return codes:
    Return code
    Description
    4
    Avaya Role is invalid.
    5
    Value of isCtiUser should be yes or no.
    6
    uid, cn or sn can contain [A-Z,a-z,0-9,_,-] and could be less than 32 characters.
    7
    Password should have at least one uppercase, one lowercase, one digit and one special character with minimum length of 8 characters.
    8
    User with this uid already exist.
    9
    User could not be <action> due to unknown reason.
    10
    The user with given uid does not exist.
    11
    The user is not a CTI user. Cannot modify unrestricted access.