PUT_gateway_newCredentials

PUT /gateway/newCredentials

This resource is used to initialize basic authentication between IP host and the ENGAGE Gateway. This should be used sequentially after a GET against the same resource. If multiple GETs are done prior to PUT, the Gateway will use the last password generated. This resource is only available after commissioning and before accepting a username/password pair.

Accepting the username/password pair, causes this resource to disappear from the Gateway API.

Default username: EngageGatewayDefaultUser
Default password: EngageGatewayDefaultPassword

Authentication

Basic Authentication: Default username and password.

NOTE: This is not the usr:pwd pair that was returned in the body of GET /gateway/newCredentials. All future Gateway operations will use the unique username and password pair which the Gateway generated.

Request

URI Parameters: None

None

Success Response(s)

HTTP status code: 201

Response parameters: <missing or should this be 'None'?>

Type: application/json

statusMessage = “Gateway username / password changed”

Error Response(s)

HTTP status code: 403

Response parameters: <missing or should this be 'None'?>

Type: application/json

statusMessage = “Credentials already established”

NOTE: 403 status is only used if the unique credentials are used. If default username/credentials are used, a 401 response is returned. <should 401 be explained as well since it could be an error response?>