Skip to main content
POST
Publish a portfolio to organisation administrators.

Authorizations

Authorization
string
header
required

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

Body

Required PortfolioName and PortfolioType set to Derivitec; the caller must own the selected portfolio.

Portfolio selection for publishing it to eligible organisation administrators.

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

Response

Returns whether the expected grants were made, with unsupported portfolio-type, ownership, or same-name collision errors.

Outcome of publishing the selected portfolio.

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