Add portfolio or book access.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/GroupAccess/Create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core",
  "group_name": "<string>",
  "include_children": false,
  "proxy_user_email": "<string>"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/GroupAccess/Create"

payload = {
    "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core",
    "group_name": "<string>",
    "include_children": False,
    "proxy_user_email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core',
    group_name: '<string>',
    include_children: false,
    proxy_user_email: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/GroupAccess/Create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/GroupAccess/Create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core',
    'group_name' => '<string>',
    'include_children' => false,
    'proxy_user_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/GroupAccess/Create"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/GroupAccess/Create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/GroupAccess/Create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Add portfolio or book access.

Grants an active other user in the caller’s organisation access to a portfolio or book owned by the caller. A portfolio requires its portfolio type; a book uses the Derivitec book type. A view-only target can receive only View access. With IncludeChildren, related portfolios and books can be attempted after the root grant; the response reports the root outcome and does not provide a child-by-child result or an all-or-nothing guarantee.

POST

api

GroupAccess

Create

Add portfolio or book access.

curl --request POST \
  --url https://api.riskportal.activeviam.com/api/GroupAccess/Create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core",
  "group_name": "<string>",
  "include_children": false,
  "proxy_user_email": "<string>"
}
'

import requests

url = "https://api.riskportal.activeviam.com/api/GroupAccess/Create"

payload = {
    "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core",
    "group_name": "<string>",
    "include_children": False,
    "proxy_user_email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    $type: 'Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core',
    group_name: '<string>',
    include_children: false,
    proxy_user_email: '<string>'
  })
};

fetch('https://api.riskportal.activeviam.com/api/GroupAccess/Create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.riskportal.activeviam.com/api/GroupAccess/Create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$type' => 'Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core',
    'group_name' => '<string>',
    'include_children' => false,
    'proxy_user_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json-patch+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.riskportal.activeviam.com/api/GroupAccess/Create"

	payload := strings.NewReader("{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.riskportal.activeviam.com/api/GroupAccess/Create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.riskportal.activeviam.com/api/GroupAccess/Create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"$type\": \"Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core\",\n  \"group_name\": \"<string>\",\n  \"include_children\": false,\n  \"proxy_user_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "$type": "Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateResponse, Derivitec.Web.Core",
  "is_success": true,
  "error_messages": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

JSON request with required ProxyUserEmail, trimmed and lowercased for an active other user in the caller's organisation; required GroupName; GroupType``Portfolio (1) or Book (2); required PortfolioType for a portfolio; AccessType``View (1), Edit (2), Full (3), or Owner (4); and optional IncludeChildren, which defaults to false.

Target user, portfolio-or-book selection, requested access level, and optional descendant inclusion for a group grant.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateRequest, Derivitec.Web.Core

group_name

string | null

Required name of the portfolio or book selected for sharing.

group_type

enum<string>

Whether group_name identifies a Portfolio or a Book.

Available options:

portfolio,

book

portfolio_type

enum<string> | null

Portfolio source used with group_name when group_type is Portfolio; null is used for a Book selection.

Available options:

derivitec,

enfusion,

orchestrade,

liquidity_book,

maia,

fund_studio,

not_set

access_type

enum<string>

Portfolio-or-book access level to grant; accepted named values are View, Edit, Full, and Owner, with no documented default.

Available options:

view,

edit,

full,

owner

include_children

boolean

Whether to attempt the same grant for descendant portfolios and books after granting the selected root portfolio; defaults to false and does not produce per-descendant outcomes.

Example:

false

proxy_user_email

string | null

Required email address of the other active organisation user who will receive the grant; no email-format rule is declared.

Response

Created

Outcome of granting access to the selected root portfolio or book.

$type

enum<string>

required

Available options:

Derivitec.Web.Core.GroupAccess.ApiGroupAccessCreateResponse, 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.

Introduction

Release and upgrades

User guide

Admin user guide

APIs Endpoints

Add portfolio or book access.

Authorizations

Body

Response