Understanding How The API Works »
Creating an UpdateUser in the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.
REST Syntax
| Click to view all REST Resources |
|
/REST/UpdateUser/ POST — Creates a new UpdateUser.
HTTP Action — POST
URIs — https://api.dynect.net/REST/UpdateUser/
|
Arguments:
The new username must be specified in the URI.
- string
nickname — Required. The nickname for the update user. Pass an empty string to have a nickname generated for you. Max length of 17 characters.
- string
password — Required. The user’s password. Pass an empty string to have a password generated for you.
|
Response:
- string
password — Password for the new UpdateUser.
- array
group_name — A list of permission groups where this user belongs.
- string
status — Current status of the user.
- string
user_name — The user’s system username; used for logging in.
|
SOAP Syntax
| Click to view all SOAP Commands |
|
CreateUpdateUser — Creates an UpdateUser, which is used for updating Dynamic DNS Services.
|
Arguments:
- string
nickname — Required. The nickname for the Contact associated with the user.
- string
password — Required. The user’s password.
- string
token — Required. The session identifier.
|
Response:
- hash
data
- string
password — Password of the new UpdateUser.
- array
group_name — A list of permission groups where this user belongs.
- string
status — Current status of the user, valid statuses are ‘blocked’ or ‘active’.
- string
user_name — The user’s system username; used for logging into the system.
|
Example Request — Click for More Info
{
'nickname'=>'updateuser1',
'password' => 'thepass',
'token'=> 'zaq12wsxcDe34rf89gt56nh',
}
|
DNS API Knowledge Base
