Authorization

Accounts

Entities

User accounts

Groups The group object Group types Retrieve group information Add members to a group Files Folders Templates Email templates Apps Errors

Groups

SmartVault allows more than one user to have access to an account at the same time. In order for this multi user design to work properly, it uses groups to organize users.

Groups can be managed through the path /nodes/grp. Each group has a set of permissions that will apply to all the members within that group.

A user will only have the permissions related to the group or groups they are members of.

GET/nodes/pth/{path}

PUT/nodes/grp/{path}/groups/{groupType}/{email}

The group object

Show group object

Group types

You can find below the roles that exists for each kind of group. There are 3 of them: account, vault and employee / client groups.

Account groups

Administratorshave full access to the account, vaults, folders and documents. This includes the ability to add and remove users, upgrade the account and modify the billing information.

Usersall the users for an account; may have access to manage an account, vaults, folders and documents.

Guestsanyone outside of the organization; may have access to view folders and manage documents.

Vault groups

Usersall the users for a vault.

Vault Managerhas the ability to create, delete, and write folders and documents as well as manage access in the vault.

Vault Full Accesshas the ability to create, delete and write documents.

Vault Full Inboxhas full control of the inbox.

Vault Read Onlyonly has the ability to read all the documents in the vault.

Employee / client groups

Usersall the users in a firm.

Firm Managersthis is a group that all individual Vault Manager groups are a member of.

Firm Employeesall the employees in a firm.

Vault Full Inboxgroup of all the users that have full control of the inbox.

Client Contactsall the contacts related to a client.

Retrieve group information

When browsing groups, you will need to include the path to the node to which you want to navigate to.
You can browse to a node, which will show you all the groups in that node, or directly to the group in that node, which will show you all the members in that group for the current node.

Remember you can also use the children query param to discover the groups structure.

?children="numberOfChildren"

GET/nodes/grp/{path}

Show example

Parameters

pathstring (optional)The path to the account, node, or group that you want to view information of. If you don't specify the path, the returned data will match the RootNodeType structure.

Request

curl --include \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
  'https://rest.smartvault.com/nodes/grp/{path}'

// Maven : Add these dependecies to your pom.xml (java6+)
// <dependency>
//     <groupId>org.glassfish.jersey.core</groupId>
//     <artifactId>jersey-client</artifactId>
//     <version>2.8</version>
// </dependency>
// <dependency>
//     <groupId>org.glassfish.jersey.media</groupId>
//     <artifactId>jersey-media-json-jackson</artifactId>
//     <version>2.8</version>
// </dependency>
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
Client client = ClientBuilder.newClient();
Response response = client.target("https://rest.smartvault.com/nodes/grp/{path}")
  .request(MediaType.APPLICATION_JSON_TYPE)
  .header("Accept", "application/json")
  .get();
System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));

var request = new XMLHttpRequest();
request.open('GET', 'https://rest.smartvault.com/nodes/grp/{path}');
request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');
request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};
request.send();

var request = require('request');
request({
  method: 'GET',
  url: 'https://rest.smartvault.com/nodes/grp/{path}',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  }}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});

$ENV{'PERL_LWP_SSL_VERIFY_HOSTNAME'} = 0;
use LWP::UserAgent;
use strict;
use warnings;
use 5.010;
use Cpanel::JSON::XS qw(encode_json decode_json);
my $ua   = LWP::UserAgent->new;
$ua->default_header("Content-Type" => "application/json");
$ua->default_header("Accept" => "application/json");
my $response = $ua->get("https://rest.smartvault.com/nodes/grp/{path}");
print $response->as_string;

from urllib2 import Request, urlopen
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
request = Request('https://rest.smartvault.com/nodes/grp/{path}', headers=headers)
response_body = urlopen(request).read()
print response_body

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://rest.smartvault.com/nodes/grp/{path}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "Content-Type: application/json",
  "Accept: application/json"
));
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);

require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'
headers = {
  :content_type => 'application/json',
  :accept => 'application/json'
}
response = RestClient.get 'https://rest.smartvault.com/nodes/grp/{path}', headers
puts response

package main
import (
	"fmt"
	"io/ioutil"
	"net/http"
)
func main() {
	client := &http.Client{}
	req, _ := http.NewRequest("GET", "https://rest.smartvault.com/nodes/grp/{path}", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Accept", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Errored when sending request to the server")
		return
	}
	defer resp.Body.Close()
	resp_body, _ := ioutil.ReadAll(resp.Body)
	fmt.Println(resp.Status)
	fmt.Println(string(resp_body))
}

//Common testing requirement. If you are consuming an API in a sandbox/test region, uncomment this line of code ONLY for non production uses.
//System.Net.ServicePointManager.ServerCertificateValidationCallback = delegate { return true; };
//Be sure to run "Install-Package Microsoft.Net.Http" from your nuget command line.
using System;
using System.Net.Http;
var baseAddress = new Uri("https://rest.smartvault.com/");
using (var httpClient = new HttpClient{ BaseAddress = baseAddress })
{
  
  httpClient.DefaultRequestHeaders.TryAddWithoutValidation("accept", "application/json");
  
  using(var response = await httpClient.GetAsync("nodes/grp/{path}{?children,acl,eprop,search,page,per_page,sort,direction}"))
  {
 
        string responseData = await response.Content.ReadAsStringAsync();
  }
}

Dim request = TryCast(System.Net.WebRequest.Create("https://rest.smartvault.com/nodes/grp/{path}"), System.Net.HttpWebRequest)
request.Method = "GET"
request.ContentType = "application/json"
request.Accept = "application/json"
request.ContentLength = 0
Dim responseContent As String
Using response = TryCast(request.GetResponse(), System.Net.HttpWebResponse)
  Using reader = New System.IO.StreamReader(response.GetResponseStream())
    responseContent = reader.ReadToEnd()
  End Using
End Using

import groovyx.net.http.RESTClient
import static groovyx.net.http.ContentType.JSON
import groovy.json.JsonSlurper
import groovy.json.JsonOutput
@Grab (group = 'org.codehaus.groovy.modules.http-builder', module = 'http-builder', version = '0.5.0')
def client = new RESTClient("https://rest.smartvault.com")
def emptyHeaders = [:]
emptyHeaders."Content-Type" = "application/json"
emptyHeaders."Accept" = "application/json"
response = client.get( path : "/nodes/grp/{path}{?children,acl,eprop,search,page,per_page,sort,direction}", headers: emptyHeaders )
println("Status:" + response.status)
if (response.data) {
  println("Content Type: " + response.contentType)
  println("Body:\n" + JsonOutput.prettyPrint(JsonOutput.toJson(response.data)))
}

NSURL *URL = [NSURL URLWithString:@"https://rest.smartvault.com/nodes/grp/{path}"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
[request setHTTPMethod:@"GET"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[request setValue:@"application/json" forHTTPHeaderField:@"Accept"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
                                        completionHandler:
                              ^(NSData *data, NSURLResponse *response, NSError *error) {
                                  if (error) {
                                      // Handle error...
                                      return;
                                  }
                                  if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
                                      NSLog(@"Response HTTP Status code: %ld\n", (long)[(NSHTTPURLResponse *)response statusCode]);
                                      NSLog(@"Response HTTP Headers:\n%@\n", [(NSHTTPURLResponse *)response allHeaderFields]);
                                  }
                                  NSString* body = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
                                  NSLog(@"Response Body:\n%@\n", body);
                              }];
[task resume];

import Foundation
// NOTE: Uncommment following two lines for use in a Playground
// import PlaygroundSupport
// PlaygroundPage.current.needsIndefiniteExecution = true
let url = URL(string: "https://rest.smartvault.com/nodes/grp/{path}")!
var request = URLRequest(url: url)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("application/json", forHTTPHeaderField: "Accept")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
  if let response = response {
    print(response)
    if let data = data, let body = String(data: data, encoding: .utf8) {
      print(body)
    }
  } else {
    print(error ?? "Unknown error")
  }
}
task.resume()

Response

Returns a group object.

Show success object

Returns an error object if the path to the group is wrong.

Show error object

Add members to a group

When adding members to a group, you will use a PUT request to /nodes/grp.
You will need to include the path to the node to which are modifying the groups of, the group you are adding the user to, and the email of the user you are adding to the group.

PUT/nodes/grp/{path}/groups/{groupType}/{email}

Parameters

pathstringPath to the account or vault and the group you are adding members to.

groupTypestringGroup you want to insert the user into.

Check group types for all the options depending on the node type.

emailstringEmail address of the user you want to add to the group.

Request

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
  'https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}'

// Maven : Add these dependecies to your pom.xml (java6+)
// <dependency>
//     <groupId>org.glassfish.jersey.core</groupId>
//     <artifactId>jersey-client</artifactId>
//     <version>2.8</version>
// </dependency>
// <dependency>
//     <groupId>org.glassfish.jersey.media</groupId>
//     <artifactId>jersey-media-json-jackson</artifactId>
//     <version>2.8</version>
// </dependency>
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
Client client = ClientBuilder.newClient();
Entity payload = Entity.json("");
Response response = client.target("https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}")
  .request(MediaType.APPLICATION_JSON_TYPE)
  .header("Accept", "application/json")
  .put(payload);
System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));

var request = new XMLHttpRequest();
request.open('PUT', 'https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}');
request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');
request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};
request.send();

var request = require('request');
request({
  method: 'PUT',
  url: 'https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  }}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});

$ENV{'PERL_LWP_SSL_VERIFY_HOSTNAME'} = 0;
use LWP::UserAgent;
use strict;
use warnings;
use 5.010;
use Cpanel::JSON::XS qw(encode_json decode_json);
my $ua   = LWP::UserAgent->new;
$ua->default_header("Content-Type" => "application/json");
$ua->default_header("Accept" => "application/json");
my $response = $ua->put("https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}");
print $response->as_string;

from urllib2 import Request, urlopen
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
request = Request('https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}', headers=headers)
request.get_method = lambda: 'PUT'
response_body = urlopen(request).read()
print response_body

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "Content-Type: application/json",
  "Accept: application/json"
));
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);

require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'
headers = {
  :content_type => 'application/json',
  :accept => 'application/json'
}
response = RestClient.put 'https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}', headers
puts response

package main
import (
	"fmt"
	"io/ioutil"
	"net/http"
)
func main() {
	client := &http.Client{}
	req, _ := http.NewRequest("PUT", "https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Accept", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		fmt.Println("Errored when sending request to the server")
		return
	}
	defer resp.Body.Close()
	resp_body, _ := ioutil.ReadAll(resp.Body)
	fmt.Println(resp.Status)
	fmt.Println(string(resp_body))
}

//Common testing requirement. If you are consuming an API in a sandbox/test region, uncomment this line of code ONLY for non production uses.
//System.Net.ServicePointManager.ServerCertificateValidationCallback = delegate { return true; };
//Be sure to run "Install-Package Microsoft.Net.Http" from your nuget command line.
using System;
using System.Net.Http;
var baseAddress = new Uri("https://rest.smartvault.com/");
using (var httpClient = new HttpClient{ BaseAddress = baseAddress })
{
  
  httpClient.DefaultRequestHeaders.TryAddWithoutValidation("accept", "application/json");
  
    using (var content = new StringContent("", System.Text.Encoding.Default, "application/json"))
    {
      using (var response = await httpClient.PutAsync("nodes/grp/{path}/groups/{groupType}/{userEmail}", content))
      {
        string responseData = await response.Content.ReadAsStringAsync();
      }
  }
}

Dim request = TryCast(System.Net.WebRequest.Create("https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}"), System.Net.HttpWebRequest)
request.Method = "PUT"
request.ContentType = "application/json"
request.Accept = "application/json"
request.ContentLength = 0
Dim responseContent As String
Using response = TryCast(request.GetResponse(), System.Net.HttpWebResponse)
  Using reader = New System.IO.StreamReader(response.GetResponseStream())
    responseContent = reader.ReadToEnd()
  End Using
End Using

import groovyx.net.http.RESTClient
import static groovyx.net.http.ContentType.JSON
import groovy.json.JsonSlurper
import groovy.json.JsonOutput
@Grab (group = 'org.codehaus.groovy.modules.http-builder', module = 'http-builder', version = '0.5.0')
def client = new RESTClient("https://rest.smartvault.com")
def emptyHeaders = [:]
emptyHeaders."Content-Type" = "application/json"
emptyHeaders."Accept" = "application/json"
def jsonObj = new JsonSlurper().parseText()
response = client.put( path : "/nodes/grp/{path}/groups/{groupType}/{userEmail}",
                        body : jsonObj,
                        headers: emptyHeaders,
                        contentType : JSON )
println("Status:" + response.status)
if (response.data) {
  println("Content Type: " + response.contentType)
  println("Body:\n" + JsonOutput.prettyPrint(JsonOutput.toJson(response.data)))
}

NSURL *URL = [NSURL URLWithString:@"https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:URL];
[request setHTTPMethod:@"PUT"];
[request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[request setValue:@"application/json" forHTTPHeaderField:@"Accept"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
                                        completionHandler:
                              ^(NSData *data, NSURLResponse *response, NSError *error) {
                                  if (error) {
                                      // Handle error...
                                      return;
                                  }
                                  if ([response isKindOfClass:[NSHTTPURLResponse class]]) {
                                      NSLog(@"Response HTTP Status code: %ld\n", (long)[(NSHTTPURLResponse *)response statusCode]);
                                      NSLog(@"Response HTTP Headers:\n%@\n", [(NSHTTPURLResponse *)response allHeaderFields]);
                                  }
                                  NSString* body = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
                                  NSLog(@"Response Body:\n%@\n", body);
                              }];
[task resume];

import Foundation
// NOTE: Uncommment following two lines for use in a Playground
// import PlaygroundSupport
// PlaygroundPage.current.needsIndefiniteExecution = true
let url = URL(string: "https://rest.smartvault.com/nodes/grp/{path}/groups/{groupType}/{userEmail}")!
var request = URLRequest(url: url)
request.httpMethod = "PUT"
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("application/json", forHTTPHeaderField: "Accept")
let task = URLSession.shared.dataTask(with: request) { data, response, error in
  if let response = response {
    print(response)
    if let data = data, let body = String(data: data, encoding: .utf8) {
      print(body)
    }
  } else {
    print(error ?? "Unknown error")
  }
}
task.resume()

Response

SmartVault

Groups

.css-1r0pe6c{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-1r0pe6c:hover{-webkit-text-decoration:underline;text-decoration:underline;}The group object

Show group object

Group types

Retrieve group information

Show example

Show success object

Show error object

Add members to a group

Show example

The group object