Porta v1.11.0
Skip to content

Applications API ​

Manage applications (SaaS products) that clients and RBAC are scoped to.

Base path: /api/admin/applications

Deployment-global entities

Applications, modules, roles, permissions, and claim definitions are shared across every organization. Creating, changing, or deleting them can affect all organizations that use the application. See the Core ownership model.

Create Application ​

http
POST /api/admin/applications
FieldTypeRequiredDescription
namestring✅Application display name
slugstringURL slug (auto-generated from name)
descriptionstringDescription of the application
json
{
  "name": "ERP System",
  "description": "Enterprise resource planning application"
}

Response: 201 Created

List Applications ​

http
GET /api/admin/applications

Supports page, pageSize, search, status, sort, order parameters.

Response: 200 OK — Paginated list of applications.

Get Application ​

http
GET /api/admin/applications/:id

Response: 200 OK — Full application object.

Update Application ​

http
PUT /api/admin/applications/:id
FieldTypeDescription
namestringDisplay name
descriptionstringDescription

Response: 200 OK

Activate / Deactivate ​

http
POST /api/admin/applications/:id/activate
POST /api/admin/applications/:id/deactivate

Response: 200 OK — Updated application with new status.

Application Modules ​

Modules are logical groupings within an application (e.g., CRM, Invoicing, HR).

Add Module ​

http
POST /api/admin/applications/:id/modules
FieldTypeRequiredDescription
namestring✅Module name
slugstringModule slug
descriptionstringModule description

List Modules ​

http
GET /api/admin/applications/:id/modules

Update Module ​

http
PUT /api/admin/applications/:id/modules/:moduleId

Deactivate Module ​

http
POST /api/admin/applications/:id/modules/:moduleId/deactivate

Delete Module ​

http
DELETE /api/admin/applications/:appId/modules/:moduleId

Permanently deletes the module and cascades to its permissions and dependent links.

Permission: admin:module:delete

Response: 204 No Content

Delete Application ​

http
DELETE /api/admin/applications/:id

Permanently deletes the deployment-global application and its modules, clients, roles, permissions, claim definitions, and dependent security data. Affected sessions and protocol authority are revoked.

Permission: admin:app:delete

Response: 204 No Content

Released under the MIT License.