1. Docs
  2. API Reference
  3. OrganizationIntegrationResponseDto

OrganizationIntegrationResponseDto

Example

JSON
{
  "id": "string",
  "client_id": "string",
  "name": "string",
  "is_active": false,
  "organization_node_id": "string",
  "created_by_name": "string",
  "last_token_at": "2026-04-20T12:00:00.000Z",
  "previous_secret_expires_at": "2026-04-20T12:00:00.000Z",
  "secret_rotated_at": "2026-04-20T12:00:00.000Z",
  "version": 0,
  "created_at": "2026-04-20T12:00:00.000Z",
  "roles": [
    {
      "id": "string",
      "identity_id": "string",
      "oauth_client_id": "string",
      "application_node_id": "string",
      "role_id": "string",
      "role_name": "string",
      "node_name": "string",
      "effective_from": "2026-04-20T12:00:00.000Z",
      "effective_to": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z",
      "updated_at": "2026-04-20T12:00:00.000Z",
      "version": 0
    }
  ],
  "connection": {
    "token_endpoint": "string",
    "audience": "string",
    "token_lifetime_seconds": 0
  }
}

Properties

13 properties 8 required

id string Required
client_id string Required

The ID a system sends to obtain a token.

name string Required
is_active boolean Required

Disabled integrations are refused new tokens.

organization_node_id string Required
created_by_name string Required

The name of the administrator who created it; null when a developer key created it or the identity is gone.

nullable
last_token_at string Optional

When it last obtained a token.

format: date-timenullable
previous_secret_expires_at string Optional

While a rotation is in its overlap, when the replaced secret stops working.

format: date-timenullable
secret_rotated_at string Optional

When the secret was last rotated. Null until the first rotation.

format: date-timenullable
version number Required

Optimistic-lock version. Send it in `If-Match` on an update to refuse a stale write.

created_at string Required
format: date-time
roles array of AssignmentResponseDto Optional

Every role it holds, on list rows.

connection object Optional

How to connect, on the single read.

Was this page helpful?

Tell us how we can improve this guide.

Canopy