Add portfolio access for a user.
Use an administrator account to grant another active same-organisation user access to a portfolio. A
view-only target can receive only View access. With IncludeChildren=true, matching access is
also attempted for descendant portfolios and books before returning; the response reports the primary
portfolio grant only and does not provide each descendant outcome.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
Required ProxyUserEmail, PortfolioName, and AccessType: View (1), Edit (2), Full (3), or Owner (4). Provide PortfolioType when the name is ambiguous; IncludeChildren defaults to false.
Target user, portfolio, access level, and descendant-inclusion choice for a new portfolio grant.
Derivitec.Web.Core.PortfolioAccess.ApiProxyUserPortfolioAccessCreateRequest, Derivitec.Web.Core Email address of the organisation user whose portfolio access is being changed.
"user@example.com"
Name of the portfolio to select. The value must not be null or empty.
"Example portfolio"
Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.
derivitec, enfusion, orchestrade, liquidity_book, maia, fund_studio, not_set Portfolio access level to grant to the selected user.
view, edit, full, owner Whether to attempt the same grant for descendant portfolios and books; defaults to false and the response reports only the primary portfolio grant.
false
Response
Created
Outcome of granting a user access to the selected portfolio.
Derivitec.Web.Core.PortfolioAccess.ApiProxyUserPortfolioAccessCreateResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.