1. Docs
  2. Portal Reference

Portal Reference

Admin and management endpoints under /portal/v1/*. Authenticated with a portal user JWT — the same kind issued when an admin signs into the dashboard. Use these from CI scripts, terraform-style provisioning, or any backend that needs to script work normally done in the dashboard.

Endpoints

Browse the portal API by resource. Each card opens to the list of operations for that resource.

Auth
POSTRegister a new userPOSTLook up invite details by tokenPOSTAccept an invitePOSTAuthenticate and receive tokensPOSTSelect an Application from a pre-auth session (post-login picker)POSTSwitch the active Application in an authenticated sessionPOSTRefresh access tokenPOSTLogout and revoke tokensGETVerify email addressPOSTResend verification emailPOSTRequest password resetPOSTReset password with tokenPOSTChange password (authenticated)GETGet current user profileGETGet current user permissionsGETList the Accounts the current user belongs toGETList active sessionsDELETERevoke all sessionsDELETERevoke a specific session
Identity Auth
POSTAuthenticate identity and receive tokensPOSTIdentity multi-App login: complete Application selection from pre-auth sessionPOSTRefresh identity access tokenPOSTLogout identity and revoke tokensPOSTVerify identity email addressPOSTResend identity verification emailPOSTRequest identity password resetPOSTReset identity password with tokenPOSTChange identity password (authenticated)GETGet current identity profileGETList identity active sessionsDELETERevoke a specific identity sessionPOSTLook up invite details by tokenPOSTAccept an invite
Identity Mfa
GETList enrolled MFA factors for the callerPOSTBegin TOTP factor enrollmentPOSTComplete TOTP factor enrollmentPOSTBegin WebAuthn factor enrollmentPOSTComplete WebAuthn factor enrollmentPOSTProve a fresh factor to authorise a sensitive MFA mutationPOSTBegin a WebAuthn-backed step-up ceremonyPOSTComplete a WebAuthn step-up ceremonyDELETERemove an enrolled MFA factorPOSTRegenerate the identity's single-use recovery codesGETList the identity's active 'remember this device' recordsDELETERevoke every trusted device for the callerDELETERevoke a single trusted device
Identity Mfa Challenge
POSTSubmit a TOTP code to satisfy an in-flight MFA challengePOSTRedeem a single-use recovery code to satisfy an in-flight MFA challengePOSTGenerate WebAuthn authentication options for an in-flight MFA challengePOSTSubmit a WebAuthn assertion to satisfy an in-flight MFA challengePOSTTrigger an email OTP for an in-flight MFA challengePOSTSubmit an email OTP to satisfy an in-flight MFA challenge
Account Applications
GETList Applications in the AccountPOSTCreate a new Application in the Account
Account Identities
GETList identities in AccountPOSTCreate an Account identityPOSTBulk-create Account identitiesGETGet directory counts for the AccountGETGet an Account identityPATCHUpdate an Account identity profilePATCHSet Account-wide is_active flagPOSTAdmin-trigger a password reset emailPOSTRe-send email verificationGETList audit events for an Account identityPOSTAdd an identity to an Application (create AppMembership)DELETERemove an identity from an Application (revoke AppMembership)
Account Identity Invites
POSTInvite an identity at the Account tier
Account Identity Mfa
GETGet MFA enrollment summary for an identityPOSTForce-reset an identity's MFA — admin recovery action
Account Members
GETList platform-admin members of the AccountDELETERemove a platform admin from the Account
Accounts
GETGet the current AccountPATCHUpdate the Account name or settings
API Keys
GETList API keys for ApplicationPOSTCreate a new API keyDELETERevoke an API key
App Memberships
POSTBulk-attach AppMemberships for the env-scoped Add-from-directory picker
Applications
GETGet the current ApplicationPATCHUpdate the Application name or settingsDELETEDelete an ApplicationPUTSet the App's default EnvironmentGETGet the admin's resume-state for this ApplicationPUTUpdate the admin's resume-state for this Application
Audit Log Admin
GETLive-tail admin audit-log events (SSE)GETQuery admin audit-log eventsGETGet an admin audit-log row with related events
Audit Log Identities
GETLive-tail identity audit-log events (SSE)GETQuery identity audit-log eventsGETGet an identity audit-log row with related events
Environments
GETList Environments in an ApplicationPOSTCreate a new Environment in an ApplicationGETGet a single Environment by slugPATCHRename or re-slug an EnvironmentDELETEDelete an EnvironmentGETExport an Environment's configuration as JSONPOSTReplace an Environment's configuration from a JSON payload (destructive)GETGet the Environment's access modelPUTSwitch the Environment's access modelGETGet hierarchy schema for the active EnvironmentPATCHUpdate hierarchy schema for the active EnvironmentPOSTRevert this Environment from hierarchy to flat
Hierarchy
GETList hierarchy (scoped tree)POSTCreate a hierarchy nodeGETGet a hierarchy nodePATCHUpdate a hierarchy nodeDELETEDelete a hierarchy nodeGETGet subtree from a nodeGETGet ancestor chain for a nodeGETGet direct children of a nodePOSTMove (reparent) a nodeGETList identities at a nodeGETGet identity summary for a node
Identities
GETList identities in ApplicationPOSTCreate an identityGETList identities with their role assignmentsGETGet Application identities summaryPOSTBulk-create identitiesPOSTRecord a bulk-import wizard completionGETGet an identityPATCHUpdate an identityDELETERemove an identityGETGet identity detail with role assignmentsPOSTActivate an identityPOSTDeactivate an identityGETGet identity's role assignmentsGETGet identity's effective permissions
Identity Invites
GETList invitesPOSTCreate an inviteGETGet invite summaryPOSTBulk-create invitesPOSTResend an inviteDELETERevoke an invite
Me Audit Views
GETList saved audit-log views for the current adminPOSTCreate or replace a saved audit-log viewDELETEDelete a saved audit-log view
Me Preferences
GETGet the admin's preferencesPATCHUpdate the admin's preferences
RBAC Assignments
GETList all assignments across the ApplicationGETGet App-wide assignment summaryPOSTAssign a role to an identity at a nodePATCHUpdate an assignmentDELETERemove an assignmentPOSTBulk remove assignmentsPOSTBulk change role on assignmentsPOSTBulk-create role assignments. All-or-nothing: any failure rolls back the entire batch
RBAC Permissions
GETList permission catalogPOSTRegister new permission(s)GETGet a permissionPATCHUpdate permission metadataDELETERemove a permission
RBAC Roles
GETList rolesPOSTCreate a custom roleGETGet a rolePATCHUpdate a roleDELETEDelete a roleGETGet permissions for a rolePUTReplace permissions on a role
Setup
POSTBootstrap the Environment's permission catalog and rolesPOSTAdd resource permissions to existing roles
Setup Summaries
GETList setup status for every Environment in the Account
User Invites
GETList invitesPOSTCreate an inviteGETGet invite summaryPOSTResend an inviteDELETERevoke an invite
Users
GETList users in AccountGETGet Account users summaryGETGet a userDELETERemove user from AccountPOSTActivate a userPOSTDeactivate a user
Webhooks
GETList webhook subscriptionsPOSTCreate a webhook subscriptionGETGet a webhook subscriptionPATCHUpdate a webhook subscriptionDELETEDelete a webhook subscription
Environment
On this page
Canopy