GET_gateway_newCredentials

GET /gateway/newCredentials

This resource is used to initialize basic authentication between IP host and the ENGAGE Gateway. Every GET request results in a new password being randomly generated, and previous randomly generated passwords are forgotten. This resource is only available after commissioning and before accepting a username/password pair.

Accepting the username/password pair (using PUT /gateway/newCredentials), causes this resource to disappear from the Gateway API. An error response is given if an attempt to access this API resource is executed after the username/password pair has been accepted.

Default username: EngageGatewayDefaultUser
Default password: EngageGatewayDefaultPassword

Authentication

Basic Authentication: Default username and password.

Request

URI Parameters: None

Success Response(s)

HTTP status code: 200

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

Type: application/json

credentials = parent
If successful, this parameter, and children are included.

usr = string
Proposed username to be used by client. Format: “gateway_(8-byte serial number)

pwd = string
Proposed password to be used by client. Randomly generated password for every request.

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?>

Example

{"credentials":{"usr":"gateway_a0b100000000003f","pwd":"eh1b1yeDuWdnHZXnYjLxN4yRdkll158f"}}

Last Modified: October 22, 2019