Submit project membership evidence
Verifies a ProjectMembershipV1 credential and indexes it as membership evidence for the project, which is how an agent becomes associated with the project. Requires edit_project_settings on the Guardian project; an unknown project is 403 like a forbidden one. Reference a credential Integrity Service already holds with source_cid or credential_id (the values returned by integrity's POST /gov/v1/identity/membership/{project_uuid}); embedding the credential directly is only accepted when embedded bootstrap is enabled. The credential's issuer must be in the configured trusted-issuer list or the evidence is indexed with status untrusted_issuer.
https://<host>/api/v1/projects/{project_uuid}/membershipscurl --request POST \
--url 'https://<host>/api/v1/projects/{project_uuid}/memberships' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"agent_did_hint":"string","credential":{"key":null},"credential_id":"string","refresh_status":true,"source_cid":"string","statement_cid":"string","statement_id":"string"}'const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/memberships", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
})
});
const data = await response.json();interface ProjectMembershipEvidenceResponseDoc {
correlation_id?: string;
item?: Record<string, unknown>;
}
const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/memberships", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
})
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ProjectMembershipEvidenceResponseDoc = await response.json();import requests
response = requests.post(
"https://<host>/api/v1/projects/{project_uuid}/memberships",
headers={
"Authorization": "Bearer <token>",
"Content-Type": "application/json",
},
json={
"agent_did_hint": "string",
"credential": {
"key": None,
},
"credential_id": "string",
"refresh_status": True,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string",
},
)
response.raise_for_status()
print(response.json())package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}`)
req, err := http.NewRequest(http.MethodPost, "https://<host>/api/v1/projects/{project_uuid}/memberships", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://<host>/api/v1/projects/{project_uuid}/memberships"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://<host>/api/v1/projects/{project_uuid}/memberships");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://<host>/api/v1/projects/{project_uuid}/memberships');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}
JSON,
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;require "net/http"
uri = URI("https://<host>/api/v1/projects/{project_uuid}/memberships")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.post("https://<host>/api/v1/projects/{project_uuid}/memberships")
.header("Authorization", "Bearer <token>")
.json(&json!({
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}))
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a sign-in token: a Guardian Platform JWT, or an OIDC ID token in a standalone deployment.ApiKeyAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a Guardian Platform API key. Project-scoped routes and registration tokens check the key's scopes and project binding. Per-agent routes accept a key bound to no project that has empty scopes or full access, which acts as its holder, or a scope for what the route does: submit_agent_assessments reads an agent (its detail, configurations, state history and the files a state references, definitions, tools and operating profile, as its assessments rest on), view_agent_certifications reads its certifications, and manage_programs or review_agent_assessments attach a certification. A state's raw snapshot and findings, its audit exchanges and plugin events, and saving its operating profile take full access. A scope counts only while the key's holder still holds that permission in the key's organization, which auth-service reports as keyHeldScopes. A key never acts as an admin, so its holder's binding to the agent still decides.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
project_uuidrequired | string | Project UUID |
Request bodyrequired
Credential source
agent_did_hintstringcredentialobjectShow properties
Map of
anycredential_idstringrefresh_statusbooleansource_cidstringstatement_cidstringstatement_idstring
{
"agent_did_hint": "string",
"credential": {
"key": null
},
"credential_id": "string",
"refresh_status": true,
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
}Responses
200OK
correlation_idstringiteminternal_controlhttp.projectAgentMembershipEvidenceDocShow internal_controlhttp.projectAgentMembershipEvidenceDoc
credential_idstringcredential_statusinternal_controlhttp.projectAgentCredentialStatusDoc[]Show properties
Array of
internal_controlhttp.projectAgentCredentialStatusDocidstringrawobjectShow properties
Map of
anystatus_list_credentialstringstatus_list_indexstringstatus_purposestringtypestring
credential_status_checked_atstringgateway_agent_idstringissuer_didstringlast_verified_atstringobserved_atstringproject_urnstringproject_uuidstringrolesstring[]sourcestringsource_refsinternal_controlhttp.projectAgentSourceRefsDocShow internal_controlhttp.projectAgentSourceRefsDoc
credential_idstringsource_cidstringstatement_cidstringstatement_idstring
status_check_attempted_atstringstatus_resolutioninternal_controlhttp.projectAgentStatusResolutionDocShow internal_controlhttp.projectAgentStatusResolutionDoc
checked_atstringmetadataobjectShow properties
Map of
anyrevokedboolean
subject_didstringThe credential's subject: a DID or the agent's urn:uuid
valid_fromstringvalid_untilstringvalidation_errorsinternal_controlhttp.projectAgentValidationErrorDoc[]Show properties
Array of
internal_controlhttp.projectAgentValidationErrorDoccodestringfieldstringmessagestring
validation_statusstring
{
"correlation_id": "string",
"item": {
"credential_id": "string",
"credential_status": [
{
"id": "string",
"raw": {
"key": null
},
"status_list_credential": "string",
"status_list_index": "string",
"status_purpose": "string",
"type": "string"
}
],
"credential_status_checked_at": "string",
"gateway_agent_id": "string",
"issuer_did": "string",
"last_verified_at": "string",
"observed_at": "string",
"project_urn": "string",
"project_uuid": "string",
"roles": [
"string"
],
"source": "string",
"source_refs": {
"credential_id": "string",
"source_cid": "string",
"statement_cid": "string",
"statement_id": "string"
},
"status_check_attempted_at": "string",
"status_resolution": {
"checked_at": "string",
"metadata": {
"key": null
},
"revoked": true
},
"subject_did": "string",
"valid_from": "string",
"valid_until": "string",
"validation_errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
],
"validation_status": "string"
}
}400Missing source, malformed credential, or signature verification failed
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}401Unauthorized
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}403Forbidden
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}404Referenced credential not found
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}409Credential project does not match route project
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}500Internal Server Error
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}502Integrity Service returned an unusable credential
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}503Service Unavailable
codestringcorrelation_idstringmessagestring
{
"code": "string",
"correlation_id": "string",
"message": "string"
}