v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Auth

Create a Connect Token

The Connect front-end component must be initialized with a Connect Token scoped to the user entering the Connect flow.

For new users, or users creating an additional utility credential, post with a unique client_user_id parameter. For users editing an existing utility credential, post with the utility_credential_id parameter corresponding to the utility credential to be updated. Make sure the Authorization header is set to Bearer ${ACCESS_TOKEN}.

Tokens expire after two hours.

post/auth/connect_token

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

client_user_idstring

The unique identifier for your user. This parameter is required for users entering the Connect flow for the first time. Note either client_user_id or utility_credential_id must be supplied to the endpoint for all requests.

utility_credential_idinteger

The id associated the utility credential to be updated. This parameter is required for users entering Connect to update an existing utility credential. Note either client_user_id or utility_credential_id must be supplied to the endpoint for all requests.

Example request

{
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
  "utility_credential_id": 1
}

Response

Success

connect_urlstring required

The url to be used for initializing standalone Connect.

Example response

{
  "connect_url": "https://connect.arcadia.com?token=QYEPoBOJWc4bV_XpIzJdr8BLG4RdK6h68AP672nab4f"
}