Download OpenAPI specification:Download
Cloud-Plugins Admin Rest API
get custom name of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or custom id not found in user
get msisdn of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist or msisdn not set for user
get uidname of user
contextid required | number context id |
userid required | number user id |
Success
Authorization error
User does not exist
get uidname of user
search required | string string to search for |
field | string Enum:"UIDNAME" "MSISDN" "CUSTOM" "ANY" field to search into |
Success
Generic error, e.g. wrong parameters
Authorization error
User not found
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
custom | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
Settings successfully updated
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
msisdn | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
change user data
contextid required | number context id |
userid required | number user id |
uidname | string |
Settings successfully updated
Generic error, e.g. wrong parameters
Authorization error
User does not exist
User does already exist
change user data
contextid required | number context id |
userid required | number user id |
custom | Array of string |
msisdn | string |
Settings successfully updated
At least one setting has been created
Generic error, e.g. wrong parameters
Authorization error
User does not exist