1. Docs
  2. API Reference
  3. Bulk-create role assignments. All-or-nothing: any failure rolls back the entire batch

Bulk-create role assignments. All-or-nothing: any failure rolls back the entire batch

POST/api/v1/assignments/bulk-create

Creates many role assignments in one request using partial-success semantics: each item is validated, authorized at its node, and saved independently. Successes and failures are returned together in a { summary, results } envelope — 200 when every item succeeds, 207 Multi-Status when some fail. Per-item duplicates (including repeats within the same batch), unauthorized nodes, and inactive/system roles fold into the failures array rather than aborting the request. Emits a single assignment.bulk_created audit summary.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Request body

application/json

assignmentsBulkCreateAssignmentItemDto[] Required

Responses

application/json

  • summaryobject*
  • resultsobject[]*

application/json

  • summaryobject*
  • results("success" | "error")[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X POST "https://auth.canopy-io.com/api/v1/assignments/bulk-create" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "assignments": [
      {
        "identity_id": "string",
        "node_id": "string",
        "role_id": "string",
        "effective_from": "string",
        "effective_to": "string"
      }
    ]
  }'
Response
{
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  },
  "results": [
    {
      "index": 0,
      "status": "success",
      "code": 0,
      "data": {
        "id": "string",
        "identity_id": "string",
        "application_node_id": "string",
        "role_id": "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"
      }
    }
  ]
}
 Related endpoints
GETList all assignments across the Application
GETGet App-wide assignment summary
POSTAssign a role to an identity at a node
PATCHUpdate an assignment
DELETERemove an assignment
POSTBulk remove assignments
POSTBulk change role on assignments
 Was this page helpful?

Tell us how we can improve this guide.

Canopy