userdir
Method list of userdir on Brekeke SIP Server.
Note: REST API feature is available on Brekeke SIP SERVER version 3.16.0 or later
userdir/delete
Description:
Delete user authentication data.
userdir
Parameters:
username – a user name or an array of user names.
Returns:
result – true or false
Example of the request body:
{
"username": "1101"
}
Example of sending request:
userdir/get
Description:
Get user authentication data.
userdir
Parameters:
username – a user name or an array of user names.
Returns:
A user object or an array of user objects.
Example of the request body:
{
"username": ["1102","1103"]
}
Example of sending request:
userdir/list
Description:
List user authentication data.
userdir
Parameters:
condition
field – field name. (optional, default:username)
text – a string to match
type – a string representing the mathing type. value can be startswith or endswith or equals
domain – domain name (optional)
offset – starting index. (optional, default:0)
limit – maximum count (optional, default:100)
Returns:
data – An array of user objects.
count
Example of the request body:
{
"condition": {
"field":"username"
"text":"11"
"type":"startswith"
}
}
Example of sending request:
userdir/set
Description:
Set user authentication data.
userdir
Parameters:
user – a user object or an array of user objects.
Returns:
result- true or false
Example of the request body:
{
"user" : {
"username": "1104",
"longname" : "Jack",
"password" : "jrtyjlasdfga",
"description" : "This is for testing.",
"email" : "jack-test@brekeke.com"
}
}
Example of sending request:
