Disconnect an outside account
household.integration.disconnect
POST/api/v1/households/{household_id}/commands/household.integration.disconnect
- Command
- Not for Rigel
- Waits for the server
Deletes the integration, its stored credential and the app records that hang off it. Records it brought in stay. Any member may disconnect any integration.
Parameters#
| Field | Description |
|---|---|
household_idpathstringrequired | The household's ID. |
Idempotency-Keyheaderstringoptional | The command's ID. Reuse it when retrying the same command. |
Request body#
JSON, as application/json.
| Field | Description |
|---|---|
integration_idstringrequired | A integration ID, such as int_01JC0000000000000000000000. |
Response#
200 The command was applied.
| Field | Description |
|---|---|
resultobjectrequired | What the command returned, such as the IDs it created. |
versionintegerrequired | The household version after the command. |
Errors#
Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.
| Status | Code | When |
|---|---|---|
400 | validation_failed | A field is missing, misspelled or out of range. details.fields lists each problem. |
401 | unauthenticated | The request has no valid session. |
404 | integration_not_found | An integration that isn't there is not found. |
404 | not_found | The household doesn't exist, or you aren't a member of it. |
409 | idempotency_key_reused | The Idempotency-Key was already used for a different command. |
Examples#
These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.
Disconnecting deletes the integration
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
-d '{
"integration_id": "int_01JC000000000000000000000A"
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
integration_id: "int_01JC000000000000000000000A",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA
{
"integration_id": "int_01JC000000000000000000000A"
}Response, 200
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0AFH2JCP38Y0H9X5W
{
"result": {},
"version": 1
}An integration that isn't there is not found
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
-d '{
"integration_id": "int_01JC000000000000000000000A"
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
integration_id: "int_01JC000000000000000000000A",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/household.integration.disconnect HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA
{
"integration_id": "int_01JC000000000000000000000A"
}Response, 404
HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R045E8KA780SK4YAHP
{
"error": {
"code": "integration_not_found",
"message": "That account isn't connected any more. No changes were applied.",
"details": {
"integration_id": "int_01JC000000000000000000000A"
},
"recovery": "Read the current state, then send a command that fits it.",
"request_id": "req_01K9D9S2R045E8KA780SK4YAHP"
}
}Disconnect an account
Deletes the stored credential. The app that used it stops syncing.
Request, curl
curl -X POST 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/household.integration.disconnect' \
-H "Cookie: rigel_session=$RIGEL_SESSION" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: cmd_01M6V9CSTVQFMK9RANTFBB1RDW' \
-d '{
"integration_id": "int_01M6V9CSTFHJQXMXWK5DX51W4V"
}'Request, TypeScript
const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/household.integration.disconnect", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Idempotency-Key": "cmd_01M6V9CSTVQFMK9RANTFBB1RDW",
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
body: JSON.stringify({
integration_id: "int_01M6V9CSTFHJQXMXWK5DX51W4V",
}),
});
const data = await response.json();Request, HTTP
POST /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/commands/household.integration.disconnect HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01M6V9CSTVQFMK9RANTFBB1RDW
{
"integration_id": "int_01M6V9CSTFHJQXMXWK5DX51W4V"
}Response, 200
HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CSTVSHB6VJ00ABNP4947
{
"result": {},
"version": 164
}For Rigel#
Rigel's tool for this command is household_integration_disconnect. Rigel doesn't have this as a tool. It's for people and scripts. The agent guide has the rest.