List enterprise connection test runs | Clerk API (unofficial showcase)

4 parameters

enterprise_connection_idstringrequired

The ID of the enterprise connection

statusarray<string>optional

Filter test runs by status (may be repeated)

limitintegeroptional

Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.

Default:10

offsetintegeroptional

Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.

Default:0

5 status codes

200A list of enterprise connection test runs

dataarray<object>required

total_countintegerrequired

Total number of test runs

402Payment required

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Authorization invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

404Resource not found

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

422Invalid request parameters

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 402 is returned: Payment required. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.testRuns.list({
  enterpriseConnectionId: "c0a80123-4567-89ab-cdef-0123456789ab",
  status: "example",
  limit: 20,
  offset: 0,
});

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "pending",
      "connection_type": "saml",
      "parsed_user_info": {
        "email_address": "user@example.com",
        "first_name": "Example Name",
        "last_name": "Example Name",
        "user_id": "550e8400-e29b-41d4-a716-446655440000"
      },
      "logs": [
        {
          "level": "example_value",
          "code": "123456",
          "short_message": "example_value",
          "message": "This is an example message."
        }
      ],
      "saml": {
        "saml_request": "example_value",
        "saml_response": "example_value",
        "relay_state": "example_value"
      },
      "oauth": {
        "id_token": "example_key_abc123",
        "access_token": "example_key_abc123",
        "user_info": "example_value"
      },
      "created_at": 1
    }
  ],
  "total_count": 42
}

Request

Response

Errors