portal-admin API · Marula PSA docs

API reference

6 operations in portal-admin. Raw spec: openapi.json.

GET/api/v1/clients/{id}/board-exposures

GET /api/clients/{id}/board-exposures — every configured row for the client (exposed or not), so admin UI can render toggles.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Responses

Status	Description
`200`

Security: bearer

PUT/api/v1/clients/{id}/board-exposures

PUT /api/clients/{id}/board-exposures — upsert one board×client row.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Request body

PutExposureRequest

Responses

Status	Description
`200`
`404`	board or client missing

Security: bearer

GET/api/v1/clients/{id}/portal-users

GET /api/clients/{id}/portal-users — directory for one client.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Responses

Status	Description
`200`

Security: bearer

POST/api/v1/clients/{id}/portal-users

POST /api/clients/{id}/portal-users — provision (invite) one identity.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Request body

CreatePortalUserRequest

Responses

Status	Description
`200`
`409`	email already provisioned

Security: bearer

PATCH/api/v1/portal-users/{id}

PATCH /api/portal-users/{id} — rename / re-tier / enable / disable / reset password.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Request body

PatchPortalUserRequest

Responses

Status	Description
`200`
`404`

Security: bearer

DELETE/api/v1/portal-users/{id}

DELETE /api/portal-users/{id} — hard removal (sessions cascade). Prefer PATCH status=disabled to preserve history.

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes

Responses

Status	Description
`200`
`404`

Security: bearer