system.account¶

Summary¶

Resource	Operation	Description
System-Account	GET /api/app/v1/sys/account/(user)	Get account info
	PUT /api/app/v1/sys/account/(user)	Modify account properties
	GET /api/app/v1/sys/account/(user)/history	Get account hisory
	PUT /api/app/v1/sys/account/admin	Update admin password
	PUT /api/app/v1/sys/account/admin/forgotpwd	Initialize password recovery
	DELETE /api/app/v1/sys/account/email	Delete appliance email
	DELETE /api/app/v1/sys/account/smtp	Delete SMTP configuration
	PUT /api/app/v1/sys/account/smtp	Setup SMTP configuration
	GET /api/app/v1/sys/account/smtp	Show SMTP configuration
	PUT /api/app/v1/sys/module/account	Change WCG password

Details¶

GET /api/app/v1/sys/account/(user)¶

Access account information.

Note

Data varies by user

New in version 1.0.

Parameters:

user (required) – User name to get information on (tech-support, email, audit)

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - user information
401 Unauthorized – Access Denied
500 Internal Server Error – Server Error - invalid user, user not configured

Accepted Authorization:

admin, audit

Example 1 - Request: Get disabled tech-support user information:

GET /api/app/v1/sys/account/tech-support HTTP/1.1
Accept: text/html

Example 1 - Response: Get disabled tech-support user information:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "hostname": "mason67"
}

Example 2 - Request: Get enabled tech-support user information:

GET /api/app/v1/sys/account/tech-support HTTP/1.1
Accept: text/html

Example 2 - Response: Get enabled tech-support user information:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "account": "tech-support",
  "hostname": "mason67",
  "passcode": "<PASSCODE>",
  "timeout": "240"
}

PUT /api/app/v1/sys/account/(user)¶

Modify account properties.

New in version 1.0.

Parameters:

user (requred) – User to modify (tech-support, email, audit)

Query Parameters:

password (optional) – New password
enabled (optional) – (True, False)
email (optional) – Email address (only available for email user)

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - account properly modified
400 Bad Request – Bad Request - invalid parameter, invalid user
401 Unauthorized – Access Denied

Accepted Authorization:

admin

Example 1 - Request: Enable audit user:

PUT /api/app/v1/sys/account/audit?enabled=True HTTP/1.1
Accept: text/html

Example 1 - Response: Enable audit user:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Success": "Password was updated, audit"
}

Example 2 - Request: Set appliance email:

PUT /api/app/v1/sys/account/email?email=<EMAIL_ADDR> HTTP/1.1
Accept: text/html

Example 2 - Response: Set appliance email:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Success": "Appliance email updated"
}

Example 3 - Request: Enable tech-support user:

PUT /api/app/v1/sys/account/tech-support?enabled=True HTTP/1.1
Accept: text/html

Example 3 - Response: Enable tech-support user:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "account": "tech-support",
  "passcode": "<PASSCODE>",
  "timeout": "240"
}

GET /api/app/v1/sys/account/(user)/history¶

Get account history for a user.

Note

Currenly only available for tech-support user.

New in version 1.0.

Parameters:

user (required) – User name to get information on (tech-support)

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - account history list
400 Bad Request – Bad Request - invalid user
401 Unauthorized – Access Denied

Accepted Authorization:

admin, audit

Example 1 - Request: Get tech-support user history:

GET /api/app/v1/sys/account/tech-support/history HTTP/1.1
Accept: text/html

Example 1 - Response: Get tech-support user history:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "history": []
}

PUT /api/app/v1/sys/account/admin¶

Update admin password.

New in version 1.0.

Query Parameters:

password (required) – New password

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - account properly modified
400 Bad Request – Bad Request - invalid parameter, invalid user
401 Unauthorized – Access Denied

Accepted Authorization:

super-admin

Example 1 - Request: Set admin password:

PUT /api/app/v1/sys/account/admin?password=<PASSWORD> HTTP/1.1
Accept: text/html

Example 1 - Response: Set admin password:

HTTP/1.1 200 OK
Content-Type: application/json

{
 "Success": "Password was updated, admin"
}

PUT /api/app/v1/sys/account/admin/forgotpwd¶

Initialize password recovery. You will either be provided a code to contact tech support, or, if you have an SMTP server setup you will be emailed your password.

New in version 1.0.

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - SMTP configuration deleted
401 Unauthorized – Access Denied

Accepted Authorization:

admin

Example 1 - Request: Password recovery for admin user with no SMTP server configured:

PUT /api/app/v1/sys/account/admin/forgotpwd HTTP/1.1
Accept: text/html

Example 1 - Response: Password recovery for admin user with no SMTP server configured:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Result": "There is no SMTP host configured and/or there is no email address configured. $To reset your password, please contact Technical Support and provide this security code: MU3H9M4S$"
}

DELETE /api/app/v1/sys/account/email¶

Delete appliance email setting.

New in version 1.0.

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - SMTP configuration deleted
401 Unauthorized – Access Denied

Accepted Authorization:

admin

Example 1 - Request: Delete email setting:

DELETE /api/app/v1/sys/account/email HTTP/1.1
Accept: text/html

Example 1 - Response: Delete email setting:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}

DELETE /api/app/v1/sys/account/smtp¶

Delete SMTP configuration.

New in version 1.0.

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - SMTP configuration deleted
401 Unauthorized – Access Denied

Accepted Authorization:

admin

Example 1 - Request: Delete SMTP configuration:

DELETE /api/app/v1/sys/account/smtp HTTP/1.1
Accept: application/json

Example 1 - Response: Delete SMTP configuration:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}

PUT /api/app/v1/sys/account/smtp¶

Sets SMTP configuration.

New in version 1.0.

Query Parameters:

host (required) – Hostname or IP address of SMTP server
port (optional) – Port for SMTP server. Defaults to 25
user (optional) – User to authenticate with against the SMTP server
password (optional) – Password for user

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - server setup successfully
400 Bad Request – Bad Request - invalid parameters
401 Unauthorized – Access Denied

Accepted Authorization:

admin

Example 1 - Request: Setup SMTP configurtion:

PUT /api/app/v1/sys/account/smtp?host=10.206.12.219&port=25&user=<USER>&password=<PASSWORD>"HTTP/1.1
Accept: text/html

Example 1 - Response: Setup SMTP configuration:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}

GET /api/app/v1/sys/account/smtp¶

Shows SMTP configuration

New in version 1.0.

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - SMTP configuration deleted
401 Unauthorized – Access Denied

Accepted Authorization:

admin, audit

Example 1 - Request: Show SMTP configuration:

GET /api/app/v1/sys/account/smtp HTTP/1.1
Accept: text/html

Example 1 - Response: Show SMTP configuration:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "auth": true,
  "host": "10.206.12.219",
  "mailaddr": "user100@gperkins.net",
  "password": "****",
  "port": 25,
  "user": "User100@esgregression.org"
}

PUT /api/app/v1/sys/module/account¶

Change WCG admin password.

New in version 1.0.

Query Parameters:

password (required) – New WCG password

Response Headers:

Content-Type – application/json

Status Codes:

200 OK – Success - password successfully changed
401 Unauthorized – Access Denied
500 Internal Server Error – Server Error - invalid user, user not configured

Accepted Authorization:

admin

Example 1 - Request: Change WCG admin password:

PUT /api/app/v1/sys/module/account?password=<PASSWORD> HTTP/1.1
Accept: text/html

Example 1 - Response: Change WCG admin password:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Success": "Password was updated"
}

system.account¶

Summary¶

Details¶

Table of Contents

Previous topic

Next topic