Function patchConnection

Remarks

• For Cognito, the connectionId is the userPoolId.

---

📥 Request

Headers:

• Authorization: Bearer <access_token> (required)
• Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

• See PatchConnectionRequest

Path Parameters:

• connectionId (required): The unique identifier of the connection to update

Query Parameters:

• None

---

📤 Response

• 200 OK – JSON stringified object representing the updated connection. See Connection.

---

❗ Errors

Status Code	Meaning	When it Happens
400	Bad Request	Missing or invalid fields in request body
401	Unauthorized	Missing or invalid authentication token
404	Not Found	Specified connection does not exist
500	Internal Server Error	Unexpected error

Error Response Format

{
  "error": "Detailed error message here"
}
Copy

---

📦 Examples

📥 Auth0 Request

PATCH /connections/exampleConnectionId
{
  "connectionBody": {
    "displayName": "Updated Connection Name",
    "metadata": {
      "key": "new_value"
    },
  }
}
Copy

📥 Cognito Request

PATCH /connections/exampleUserPoolId
{
  "provider": "cognito-connection",
  "connectionBody": {
    "name": "Updated Connection Name",
    "metadata": {
      "key": "new_value"
    },
  }
}
Copy

📤 Response Example

{
  "connectionId": "connection_id",
  "name": "Updated Connection Name",
  "type": "connection_type",
  "status": "active|inactive",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "metadata": {
    "key": "new_value"
  },
  "configuration": {
    "setting": "value"
  }
Copy

---