Skip to main content
POST
Set a user's sharing permissions for a saved report view.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Path Parameters

reportDefinitionId
string
required

The opaque report-definition identifier that owns the saved view.

view
string
required

The opaque saved-view identifier returned when the view was created.

Body

The body containing a non-empty target email or username and the Read, Write, and Share values to grant or remove.

Parameters controlling user's permissions over a view

$type
enum<string>
required
Available options:
Derivitec.RiskPortal.Api.Controllers.ReportViewPermissionRequest, Derivitec.RiskPortal.Api
target_user
string | null

Email/Username of the target User

read
boolean

Can the user read the view

write
boolean

Can the user update the view

share
boolean

Can the user Share the view

Response

Returns the permission-change outcome in the response envelope; no updated view or permission list is included.

Response returned after changing a user's permissions for a saved report view.

$type
enum<string>
required
Available options:
Derivitec.Core.Mediators.ReportView.ShareReportViewWithEmailResponse, Derivitec.Core.Mediators
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.