Create Access Profile Grant - Serval Documentation

POST

/

v2

/

access-profile-grants

Create Access Profile Grant

curl --request POST \
  --url https://public.api.serval.com/v2/access-profile-grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessProfileId": "<string>",
  "workflowId": "<string>",
  "appResourceRoleId": "<string>",
  "formId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-profile-grants"

payload = {
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessProfileId: '<string>',
    workflowId: '<string>',
    appResourceRoleId: '<string>',
    formId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/access-profile-grants', 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://public.api.serval.com/v2/access-profile-grants",
  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([
    'accessProfileId' => '<string>',
    'workflowId' => '<string>',
    'appResourceRoleId' => '<string>',
    'formId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/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://public.api.serval.com/v2/access-profile-grants"

	payload := strings.NewReader("{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/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://public.api.serval.com/v2/access-profile-grants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-profile-grants")

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'
request.body = "{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>",
    "knowledgeItemId": "<string>",
    "excluded": true,
    "tracksTeamDefaultAccessProfile": true,
    "createdAt": "2025-01-15T01:30:15.000Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

accessProfileId

string

required

The ID of the access profile the grant attaches to.

workflowId

string | null

Exactly one of the resource id fields below must be set; the field carries the resource kind. The resource must belong to the profile's team. Knowledge-item grants are read-only on this API (returned by the Get/List endpoints): knowledge gating is managed in-app, where grants inherit through the folder tree.

The ID of the workflow to grant.

appResourceRoleId

string | null

The ID of the app resource role to grant. A role belongs to at most one profile: granting it here removes it from any profile that currently holds it.

formId

string | null

The ID of the form to add this profile's users to the audience of.

Response

200 - application/json

Success

data

data · object

The kind of resource an access profile grant attaches to. One access-profile-to-resource attachment. For workflows and app resource roles the profile grants access; for forms it narrows the audience (a form with no grants is open to anyone in the org). Exactly one of the resource id fields is set; the field itself carries the resource kind, so cross-team tooling can resolve each id against its own resource type.

Show child attributes

Create Access Profile Grant

curl --request POST \
  --url https://public.api.serval.com/v2/access-profile-grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accessProfileId": "<string>",
  "workflowId": "<string>",
  "appResourceRoleId": "<string>",
  "formId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-profile-grants"

payload = {
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    accessProfileId: '<string>',
    workflowId: '<string>',
    appResourceRoleId: '<string>',
    formId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/access-profile-grants', 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://public.api.serval.com/v2/access-profile-grants",
  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([
    'accessProfileId' => '<string>',
    'workflowId' => '<string>',
    'appResourceRoleId' => '<string>',
    'formId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/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://public.api.serval.com/v2/access-profile-grants"

	payload := strings.NewReader("{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/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://public.api.serval.com/v2/access-profile-grants")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-profile-grants")

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'
request.body = "{\n  \"accessProfileId\": \"<string>\",\n  \"workflowId\": \"<string>\",\n  \"appResourceRoleId\": \"<string>\",\n  \"formId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>",
    "knowledgeItemId": "<string>",
    "excluded": true,
    "tracksTeamDefaultAccessProfile": true,
    "createdAt": "2025-01-15T01:30:15.000Z"
  }
}