Skip to main content
POST
Add portfolio access for a user.

Authorizations

Authorization
string
header
required

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.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PortfolioAccess.ApiProxyUserPortfolioAccessCreateRequest, Derivitec.Web.Core
proxy_user_email
string | null

Email address of the organisation user whose portfolio access is being changed.

Example:

"user@example.com"

portfolio_name
string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
access_type
enum<string>

Portfolio access level to grant to the selected user.

Available options:
view,
edit,
full,
owner
include_children
boolean

Whether to attempt the same grant for descendant portfolios and books; defaults to false and the response reports only the primary portfolio grant.

Example:

false

Response

Created

Outcome of granting a user access to the selected portfolio.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.PortfolioAccess.ApiProxyUserPortfolioAccessCreateResponse, Derivitec.Web.Core
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.