1. Docs
  2. API Reference
  3. AssignmentResponseDto

AssignmentResponseDto

Example

JSON
{
  "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
}

Properties

12 properties 10 required

id string Required
identity_id string Required

The identity holding the role; null when a machine client holds it.

nullable
oauth_client_id string Required

The machine OAuth client holding the role; null when a person holds it.

nullable
application_node_id string Required
role_id string Required
role_name string Required

The role's name, when the read loaded it.

nullable
node_name string Required

The node's name, when the read loaded it.

nullable
effective_from string Optional
format: date-timenullable
effective_to string Optional
format: date-timenullable
created_at string Required
format: date-time
updated_at string Required
format: date-time
version number Required

Optimistic-lock version; send it back as `If-Match`

Was this page helpful?

Tell us how we can improve this guide.

Canopy