Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

Request

Response

Description

POST /portals

CreateOrUpdatePortalRequest

Portal

Register a new Portal with Synapse, only synapse administrators can invoke this API. The user will be automatically assigned all the ACL for the portal (update, permissions etc).

PUT /portals/{id}

CreateOrUpdatePortalRequest

Portal

Updates the metadata of the portal with the id in the path. Only users with UPDATE permissions are allowed to perform this operation.

GET /portals?

ListPortalPageResponse

Allows to fetch a page of portals, any user can invoke this operation. We might want to add filters by url, or name.

GET /portals/{id}

Portal

Fetches a portal with the id in the path. Any user can invoke this operation

GET /portals/{id}/acl

AccessControlList

Fetches the ACL for the portal with the id in the path. An ACL will always exist for a portal. Any user can invoke this operation.

PUT /portals/{id}/acl

AccessControlList

AccessControlList

Updates the ACL for the portal with the id in the path. Only users with CHANGE_PERMISSIONS permission can update the ACL.

...