Credentials

Retrieve Sensitive Credentials

This endpoint allows you to retrieve the passwords for a given credential. You must be an admin user to use this endpoint.

This endpoint supports Sandbox Mode.

get/plug/credentials/{credentialId}/passwords

Request

  • Base URL: https://api.arcadia.com
  • URL: https://api.arcadia.com/plug/credentials/{credentialId}/passwords
  • Auth: OAuth 2 (client credentials, token URL /oauth2/token)

Path parameters

credentialIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

idstring required

A unique identifier for the entity.

passwordstring required

A sensitive input required to access the customer's utility data. This will not be returned in any GET calls for the request object.

password2string required

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

password3string required

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

password4string required

Optional sensitive input required by some providers to access data. The provider object will denote which fields are required for each provider. Like password, this value will not be returned in any GET calls for the request object.

usernamestring required

A login input required to access the customer's utility data.

username2string required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider.

username3string required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider.

username4string required

Optional parameters required by some providers to access data. The provider object will denote which fields are required for each provider.

Changes

No recorded changes to this operation across all 1 revision of this API.