Account operations
Create User
Creates a new user.
Signature: create(cinfo)
Parameters:
cinfo['acctid'] - Identifier for the user that should be created
cinfo['modeluid'] - Identifier for the template account
cinfo['attributes'] - The attributes to be set on the new user
cinfo['newpw'] - The password that should be set on the new user
Return Value:
ACSuccess 0
ACUnknownError 1
ACObjectAlreadyExists 6
ACInvalidUser 7
ACInvalidModelUser 8
Remarks:
The agent.stableId, agent.longId, agent.shortId and agent.addAccountAttr callbacks should be used to return information on the created user. See the callback section for full details on the individual callbacks.
The template account should be used for attributes with the "COPY" or "REPLACE" actions to be able to determine what value should be set for the attribute. For full details on attributes see the attributes definitions section.
Delete User
Deletes a user.
Signature: delete(cinfo)
Parameters:
cinfo['acctid'] - The user that should be deleted
Return Value:
ACSuccess 0
ACUnknownError 1
ACInvalidUser 7
Move Context
Moves a user to a different context
Signature: movecontext(cinfo)
Parameters:
cinfo['acctid'] - The user that should be moved
cinfo['attributes'] - Optional attributes that can be used to indicate the new context
Return Value:
ACSuccess 0
ACUnknownError 1
ACInvalidUser 7
Rename User
Renames a user.
Signature: rename(cinfo)
Parameters:
cinfo['acctid'] - The user that should be renamed
cinfo['modeluid'] - The identifier the user should be renamed to
Return Value:
ACSuccess 0
ACUnknownError 1
ACInvalidUser 7
Update User
Updates the attributes of a user.
Signature: update(cinfo)
Parameters:
cinfo['acctid'] - The user that should be moved
cinfo['attributes'] - Optional attributes that can be used to indicate the new context
Return Value:
ACSuccess 0
ACUnknownError 1
ACInvalidUser 7
Remarks:
The agent.stableId, agent.longId, agent.shortId and agent.addAccountAttr callbacks should be used to return information on the updated user. See the callback section for full details on the individual callbacks.
User Attributes
Queries attributes for a single user.
Signature: userattributes(cinfo)
Parameters:
cinfo['acctid'] - The user that should be moved
Return Value:
ACSuccess 0
ACUnknownError 1
ACInvalidUser 7
Remarks:
The agent.addAccountAttr callback should be used to return information on the user. See the callback section for full details on the individual callbacks.