audit
Create audit engagements
Requires scopes: admin:workspace
POST
/
api
/
audit
/
engagements
Create audit engagements
curl --request POST \
--url https://evalgate.com/api/audit/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"periodInclusivity": "start_inclusive_end_exclusive"
}
'import requests
url = "https://evalgate.com/api/audit/engagements"
payload = {
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"periodInclusivity": "start_inclusive_end_exclusive"
}
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({
title: '<string>',
controlObjective: '<string>',
criteriaSource: '<string>',
unitOfTesting: '<string>',
periodStart: '<string>',
periodEnd: '<string>',
timezone: '<string>',
evidenceCutoff: '<string>',
preparerUserId: '<string>',
reviewerUserId: '<string>',
periodInclusivity: 'start_inclusive_end_exclusive'
})
};
fetch('https://evalgate.com/api/audit/engagements', 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://evalgate.com/api/audit/engagements",
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([
'title' => '<string>',
'controlObjective' => '<string>',
'criteriaSource' => '<string>',
'unitOfTesting' => '<string>',
'periodStart' => '<string>',
'periodEnd' => '<string>',
'timezone' => '<string>',
'evidenceCutoff' => '<string>',
'preparerUserId' => '<string>',
'reviewerUserId' => '<string>',
'periodInclusivity' => 'start_inclusive_end_exclusive'
]),
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://evalgate.com/api/audit/engagements"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\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://evalgate.com/api/audit/engagements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/audit/engagements")
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 \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"periodInclusivity": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"status": "<string>",
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Body
application/json
Available options:
start_inclusive_end_exclusive Response
Successful response
⌘I
Create audit engagements
curl --request POST \
--url https://evalgate.com/api/audit/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"periodInclusivity": "start_inclusive_end_exclusive"
}
'import requests
url = "https://evalgate.com/api/audit/engagements"
payload = {
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"periodInclusivity": "start_inclusive_end_exclusive"
}
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({
title: '<string>',
controlObjective: '<string>',
criteriaSource: '<string>',
unitOfTesting: '<string>',
periodStart: '<string>',
periodEnd: '<string>',
timezone: '<string>',
evidenceCutoff: '<string>',
preparerUserId: '<string>',
reviewerUserId: '<string>',
periodInclusivity: 'start_inclusive_end_exclusive'
})
};
fetch('https://evalgate.com/api/audit/engagements', 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://evalgate.com/api/audit/engagements",
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([
'title' => '<string>',
'controlObjective' => '<string>',
'criteriaSource' => '<string>',
'unitOfTesting' => '<string>',
'periodStart' => '<string>',
'periodEnd' => '<string>',
'timezone' => '<string>',
'evidenceCutoff' => '<string>',
'preparerUserId' => '<string>',
'reviewerUserId' => '<string>',
'periodInclusivity' => 'start_inclusive_end_exclusive'
]),
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://evalgate.com/api/audit/engagements"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\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://evalgate.com/api/audit/engagements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/audit/engagements")
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 \"title\": \"<string>\",\n \"controlObjective\": \"<string>\",\n \"criteriaSource\": \"<string>\",\n \"unitOfTesting\": \"<string>\",\n \"periodStart\": \"<string>\",\n \"periodEnd\": \"<string>\",\n \"timezone\": \"<string>\",\n \"evidenceCutoff\": \"<string>\",\n \"preparerUserId\": \"<string>\",\n \"reviewerUserId\": \"<string>\",\n \"periodInclusivity\": \"start_inclusive_end_exclusive\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"controlObjective": "<string>",
"criteriaSource": "<string>",
"unitOfTesting": "<string>",
"periodStart": "<string>",
"periodEnd": "<string>",
"periodInclusivity": "<string>",
"timezone": "<string>",
"evidenceCutoff": "<string>",
"preparerUserId": "<string>",
"reviewerUserId": "<string>",
"status": "<string>",
"createdBy": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}