Roles API
Reclaim Reclamation Candidate
Reclaim an in-review reclamation candidate: conclude its review as reclaimed and start deprovisioning the grant. A manage-level action — the caller need not be an assigned reviewer. Returns the updated reclamation.
POST
/
v2
/
teams
/
{team_id}
/
reclamation-candidates
/
{id}
/
reclaim
Reclaim Reclamation Candidate
curl --request POST \
--url https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"justification": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim"
payload = { "justification": "<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({justification: '<string>'})
};
fetch('https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim', 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/teams/{team_id}/reclamation-candidates/{id}/reclaim",
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([
'justification' => '<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/teams/{team_id}/reclamation-candidates/{id}/reclaim"
payload := strings.NewReader("{\n \"justification\": \"<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/teams/{team_id}/reclamation-candidates/{id}/reclaim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"justification\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim")
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 \"justification\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"entitlementId": "<string>",
"userId": "<string>",
"appInstanceId": "<string>",
"resourceType": "<string>",
"status": "RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED",
"createdAt": "2025-01-15T01:30:15.000Z",
"concludedAt": "2025-01-15T01:30:15.000Z",
"lastLoginAt": "2025-01-15T01:30:15.000Z",
"decidedByUserId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The reclamation-candidate reclamation to reclaim.
Body
application/json
Response
200 - application/json
Success
An reclamation-candidate reclamation: one entitlement grant flagged for review or reclaim because the user stopped signing in. References are bare IDs; resolve entitlement, app instance and user via their own endpoints.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Reclaim Reclamation Candidate
curl --request POST \
--url https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"justification": "<string>"
}
'import requests
url = "https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim"
payload = { "justification": "<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({justification: '<string>'})
};
fetch('https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim', 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/teams/{team_id}/reclamation-candidates/{id}/reclaim",
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([
'justification' => '<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/teams/{team_id}/reclamation-candidates/{id}/reclaim"
payload := strings.NewReader("{\n \"justification\": \"<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/teams/{team_id}/reclamation-candidates/{id}/reclaim")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"justification\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public.api.serval.com/v2/teams/{team_id}/reclamation-candidates/{id}/reclaim")
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 \"justification\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"teamId": "<string>",
"entitlementId": "<string>",
"userId": "<string>",
"appInstanceId": "<string>",
"resourceType": "<string>",
"status": "RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED",
"createdAt": "2025-01-15T01:30:15.000Z",
"concludedAt": "2025-01-15T01:30:15.000Z",
"lastLoginAt": "2025-01-15T01:30:15.000Z",
"decidedByUserId": "<string>"
}
}
