1. Docs
  2. API Reference
  3. Record a bulk-import wizard completion

Record a bulk-import wizard completion

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/identities/bulk-import-events

Records a single audit entry summarizing a completed CSV bulk-import wizard run (mode of create or invite, plus total/succeeded/failed/skipped counts); the per-batch create/invite entries are emitted separately by the bulk endpoints themselves. Writes no entity rows and returns 204 No Content. Requires the identity.manage permission.

Authentication

Bearer TokenAuthorization

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

Requires capability env_identities.manageDeveloper Console

Create, invite, edit, and remove identities and assign their roles. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Request body

application/json

modeenum Required

one of "create" · "invite"

totalnumber Required

Total rows the wizard processed (succeeded + failed).

succeedednumber Required
failednumber Required
skippednumber Optional

Rows the admin explicitly skipped (deselected in the preview, or unsent after a cancel).

Responses

Bulk-import wizard fired its completion event. Surfaces a single audit-log entry summarising the wizard run (mode, totals) so admins can ask 'did anyone run a bulk import this week?' without correlating per-batch events.

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/identities/bulk-import-events" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "create",
    "total": 0,
    "succeeded": 0,
    "failed": 0,
    "skipped": 0
  }'
Response
HTTP/1.1 204 Bulk-import wizard fired its completion event. Surfaces a single audit-log entry summarising the wizard run (mode, totals) so admins can ask 'did anyone run a bulk import this week?' without correlating per-batch events.

(empty body)
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
GETGet Application identities summary
POSTBulk-create identities
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
GETGet identity's role assignments
GETGet identity's effective permissions
 Was this page helpful?

Tell us how we can improve this guide.

Canopy