Getting Started

Quick Start Guide

Core Concepts

Account Structure

Assign Permissions

Developers

SDKs and Libraries

API Reference

API Keys

List API keys for Application

Create a new API key

Revoke an API key

Assignments

List all assignments across the Application

Get App-wide assignment summary

Assign a role to an identity at a node

Update an assignment

Remove an assignment

Bulk remove assignments

Bulk change role on assignments

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

Audit Events

Query identity audit events

Get an identity audit event with related events

Hierarchy Schema

Get hierarchy schema for the active Environment

Update hierarchy schema for the active Environment

Identities

List identities in Application

Create an identity

List identities with their role assignments

Get Application identities summary

Bulk-create identities

Get an identity

Update an identity

Remove an identity

Get identity detail with role assignments

Activate an identity

Deactivate an identity

Get identity's role assignments

Get identity's effective permissions

Identity Invites

Create an invite

Get invite summary

Bulk-create invites

Resend an invite

Revoke an invite

Nodes

List hierarchy (scoped tree)

Create a hierarchy node

Get a hierarchy node

Update a hierarchy node

Delete a hierarchy node

Get subtree from a node

Get ancestor chain for a node

Get direct children of a node

Move (reparent) a node

List identities at a node

Get identity summary for a node

Permissions

List permission catalog

Register new permission(s)

Get a permission

Update permission metadata

Remove a permission

Evaluate authorization

Bulk evaluate authorization

Roles

Create a custom role

Get permissions for a role

Replace permissions on a role

Webhooks

List webhook subscriptions

Create a webhook subscription

Get a webhook subscription

Update a webhook subscription

Delete a webhook subscription

Docs
API Reference
UsersSummaryDto

The UsersSummaryDto object

Example

{
  "total_users": 0,
  "active_count": 0,
  "inactive_count": 0
}

Properties

total_usersnumber*
active_countnumber*
inactive_countnumber*

Canopy