Update the user information in the context of a repository.
curl --request PATCH \
--url https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id} \
--header 'Content-Type: application/json' \
--data '
{
"notificationInterest": {
"system": true,
"findingCreated": true,
"findingUpdated": true,
"commentsAll": true,
"commentsReply": true,
"assigned": true
},
"immediateNotificationFindingSeverity": {
"critical": true,
"high": true,
"medium": true,
"low": true,
"informational": true,
"gasOptimization": true
},
"notificationFindingAssetGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"notificationFindingSafeHarbor": true
}
'import requests
url = "https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}"
payload = {
"notificationInterest": {
"system": True,
"findingCreated": True,
"findingUpdated": True,
"commentsAll": True,
"commentsReply": True,
"assigned": True
},
"immediateNotificationFindingSeverity": {
"critical": True,
"high": True,
"medium": True,
"low": True,
"informational": True,
"gasOptimization": True
},
"notificationFindingAssetGroupIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"notificationFindingSafeHarbor": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
notificationInterest: {
system: true,
findingCreated: true,
findingUpdated: true,
commentsAll: true,
commentsReply: true,
assigned: true
},
immediateNotificationFindingSeverity: {
critical: true,
high: true,
medium: true,
low: true,
informational: true,
gasOptimization: true
},
notificationFindingAssetGroupIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
notificationFindingSafeHarbor: true
})
};
fetch('https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}', 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.example.com/api/v0/repositories/{repo_id}/users/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'notificationInterest' => [
'system' => true,
'findingCreated' => true,
'findingUpdated' => true,
'commentsAll' => true,
'commentsReply' => true,
'assigned' => true
],
'immediateNotificationFindingSeverity' => [
'critical' => true,
'high' => true,
'medium' => true,
'low' => true,
'informational' => true,
'gasOptimization' => true
],
'notificationFindingAssetGroupIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'notificationFindingSafeHarbor' => true
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}"
payload := strings.NewReader("{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}")
.header("Content-Type", "application/json")
.body("{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Repositories
Update the user information in the context of a repository.
Access control rules
- The requester must have access to the repository, they can update their own information.
- Repository admins can update any users’ information.
PATCH
/
api
/
v0
/
repositories
/
{repo_id}
/
users
/
{user_id}
Update the user information in the context of a repository.
curl --request PATCH \
--url https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id} \
--header 'Content-Type: application/json' \
--data '
{
"notificationInterest": {
"system": true,
"findingCreated": true,
"findingUpdated": true,
"commentsAll": true,
"commentsReply": true,
"assigned": true
},
"immediateNotificationFindingSeverity": {
"critical": true,
"high": true,
"medium": true,
"low": true,
"informational": true,
"gasOptimization": true
},
"notificationFindingAssetGroupIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"notificationFindingSafeHarbor": true
}
'import requests
url = "https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}"
payload = {
"notificationInterest": {
"system": True,
"findingCreated": True,
"findingUpdated": True,
"commentsAll": True,
"commentsReply": True,
"assigned": True
},
"immediateNotificationFindingSeverity": {
"critical": True,
"high": True,
"medium": True,
"low": True,
"informational": True,
"gasOptimization": True
},
"notificationFindingAssetGroupIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"notificationFindingSafeHarbor": True
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
notificationInterest: {
system: true,
findingCreated: true,
findingUpdated: true,
commentsAll: true,
commentsReply: true,
assigned: true
},
immediateNotificationFindingSeverity: {
critical: true,
high: true,
medium: true,
low: true,
informational: true,
gasOptimization: true
},
notificationFindingAssetGroupIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
notificationFindingSafeHarbor: true
})
};
fetch('https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}', 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.example.com/api/v0/repositories/{repo_id}/users/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'notificationInterest' => [
'system' => true,
'findingCreated' => true,
'findingUpdated' => true,
'commentsAll' => true,
'commentsReply' => true,
'assigned' => true
],
'immediateNotificationFindingSeverity' => [
'critical' => true,
'high' => true,
'medium' => true,
'low' => true,
'informational' => true,
'gasOptimization' => true
],
'notificationFindingAssetGroupIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'notificationFindingSafeHarbor' => true
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}"
payload := strings.NewReader("{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}")
.header("Content-Type", "application/json")
.body("{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/repositories/{repo_id}/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"notificationInterest\": {\n \"system\": true,\n \"findingCreated\": true,\n \"findingUpdated\": true,\n \"commentsAll\": true,\n \"commentsReply\": true,\n \"assigned\": true\n },\n \"immediateNotificationFindingSeverity\": {\n \"critical\": true,\n \"high\": true,\n \"medium\": true,\n \"low\": true,\n \"informational\": true,\n \"gasOptimization\": true\n },\n \"notificationFindingAssetGroupIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"notificationFindingSafeHarbor\": true\n}"
response = http.request(request)
puts response.read_body{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Body
application/json
Update User information in the context of a repository.
When the interests are deleted it will use the user's default notification interest.
Show child attributes
Show child attributes
When the frequency is deleted it will use the user's default notification frequency.
Available options:
immediate, daily, default Specifies whether the user wants to receive immediate notifications for findings with specific severities.
Show child attributes
Show child attributes
Role the user has in the repository.
Allowed changes:
| From | To client | To judge | To triager | To reviewer | To admin |
|---|---|---|---|---|---|
| Client | No-op | Ok | Ok | No | Not in competitions |
| Judge | Ok | No-op | Ok | No | Yes |
| Triager | Ok | Ok | No-op | No | Yes |
| Reviewer | No | No | No | No-op | No |
| Admin | Ok | Ok | Ok | No | No-op |
Available options:
client, reviewer, judge, triager, admin Asset group IDs for filtering finding notifications.
Safe harbor asset notification preference.
Response
Update successful
⌘I