Function getConnection

Remarks

• For Cognito, the connectionId is the userPoolId.

---

📥 Request

Headers:

• Authorization: Bearer <access_token> (required)

Body:

• None

Path Parameters:

• connectionId: The connection ID of which connection to retrieve (required)

Query Parameters:

• provider: The authentication provider to use (optional, defaults to "auth0-connection" if omitted). See ConnectionProvider for valid options.

---

📤 Response

• 200 OK – JSON stringified object represented the retrieved connection 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

GET /connections/exampleConnectionId
Copy

📥 Cognito Request

GET /connections/exampleUserPoolId?provider=cognito-connection
Copy

📤 Response Example

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

---