EQTY LabDocs

Get project agent

Returns a project-scoped agent only when it has membership evidence for this project: a registered agent, by its ID or one of its keys' DIDs, or a DID no agent holds. It lists every key when a membership names the agent, and otherwise only the keys memberships name. Each key says how it joined the agent, never who added it.

gethttps://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}
bash
curl --request GET \
  --url 'https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface ProjectAgentDetailResponseDoc {
  correlation_id?: string;
  item?: Record<string, unknown>;
}

const response = await fetch("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: ProjectAgentDetailResponseDoc = await response.json();
python
import requests

response = requests.get(
    "https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	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))
}
java
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}/agents/{agent_id}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://<host>/api/v1/projects/{project_uuid}/agents/{agent_id}")
        .header("Authorization", "Bearer <token>")
        .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

NameTypeDescription
project_uuid
required
string

Guardian project UUID

agent_id
required
string

Gateway agent ID, or a DID

Responses

200OK

application/json
  • correlation_idstring
  • iteminternal_controlhttp.projectAgentDetailDoc
    Show internal_controlhttp.projectAgentDetailDoc
    • agent_idstring
    • app_typestring
    • badgesgithub_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentBadge[]
      Show properties

      Array of github_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentBadge

      • descriptionstring
      • first_observed_atstring
      • keystring
      • labelstring
      • last_observed_atstring
      • metadataobject
        Show properties

        Map of any

      • metadata_typestring
      • plugin_idstring
      • statusstring
      • subject_didstring
    • current_configurationobject
    • did_sourcestring
    • display_namestring
    • frameworkobject

      The framework of the definition the agent's newest state, in any project, names, as app_type is; a project's own current definition is on its definitions route

      Show properties
      • namestring
      • packagesobject
        Show properties

        Map of string

    • keysgithub_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentKey[]
      Show properties

      Array of github_com_eqtylab_gateway_control-plane_service_internal_discovery.AgentKey

      • added_bystring

        Who added it; told only to an admin and the agent's operators

      • added_by_api_key_idstring

        The API key's public ID; told only to an admin and the agent's operators

      • added_by_emailstring

        Their email; told only to an admin and the agent's operators

      • added_viastring (enum)

        AddedVia is how the key joined its agent: registration_token, api_key or control_plane; empty when no record of it survives. AddedBy is the subject of whoever added it, the registering principal or the admin, and AddedByAPIKeyID the API key's public ID.

        One ofregistration_tokenapi_keycontrol_plane

      • created_atstring
      • didstring
      • statusstring
      • updated_atstring
    • last_activity_atstring
    • logs_supportedboolean
    • membership_evidenceinternal_controlhttp.projectAgentMembershipEvidenceDoc[]
      Show properties

      Array of internal_controlhttp.projectAgentMembershipEvidenceDoc

      • credential_idstring
      • credential_statusinternal_controlhttp.projectAgentCredentialStatusDoc[]
        Show properties

        Array of internal_controlhttp.projectAgentCredentialStatusDoc

        • idstring
        • rawobject
          Show properties

          Map of any

        • status_list_credentialstring
        • status_list_indexstring
        • status_purposestring
        • typestring
      • credential_status_checked_atstring
      • gateway_agent_idstring
      • issuer_didstring
      • last_verified_atstring
      • observed_atstring
      • project_urnstring
      • project_uuidstring
      • rolesstring[]
      • sourcestring
      • source_refsinternal_controlhttp.projectAgentSourceRefsDoc
        Show internal_controlhttp.projectAgentSourceRefsDoc
        • credential_idstring
        • source_cidstring
        • statement_cidstring
        • statement_idstring
      • status_check_attempted_atstring
      • status_resolutioninternal_controlhttp.projectAgentStatusResolutionDoc
        Show internal_controlhttp.projectAgentStatusResolutionDoc
        • checked_atstring
        • metadataobject
          Show properties

          Map of any

        • revokedboolean
      • subject_didstring

        The credential's subject: a DID or the agent's urn:uuid

      • valid_fromstring
      • valid_untilstring
      • validation_errorsinternal_controlhttp.projectAgentValidationErrorDoc[]
        Show properties

        Array of internal_controlhttp.projectAgentValidationErrorDoc

        • codestring
        • fieldstring
        • messagestring
      • validation_statusstring
    • membership_statestring
    • primary_didstring
    • primary_user_display_namestring
    • state_cids_supportedboolean
    • statusstring
    • subject_didstring

      The row's identity: the agent's ID (its urn:uuid) for a registered agent, whether its memberships name the agent or its keys, or the DID no agent holds

    • throughputinteger[]
Examplejson
{
  "correlation_id": "string",
  "item": {
    "agent_id": "string",
    "app_type": "string",
    "badges": [
      {
        "description": "string",
        "first_observed_at": "string",
        "key": "string",
        "label": "string",
        "last_observed_at": "string",
        "metadata": {
          "key": null
        },
        "metadata_type": "string",
        "plugin_id": "string",
        "status": "string",
        "subject_did": "string"
      }
    ],
    "current_configuration": {},
    "did_source": "string",
    "display_name": "string",
    "framework": {
      "name": "string",
      "packages": {
        "key": "string"
      }
    },
    "keys": [
      {
        "added_by": "string",
        "added_by_api_key_id": "string",
        "added_by_email": "string",
        "added_via": "registration_token",
        "created_at": "string",
        "did": "string",
        "status": "string",
        "updated_at": "string"
      }
    ],
    "last_activity_at": "string",
    "logs_supported": true,
    "membership_evidence": [
      {
        "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"
      }
    ],
    "membership_state": "string",
    "primary_did": "string",
    "primary_user_display_name": "string",
    "state_cids_supported": true,
    "status": "string",
    "subject_did": "string",
    "throughput": [
      0
    ]
  }
}

401Unauthorized

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

403Forbidden

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

404Not Found

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

500Internal Server Error

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}

503Service Unavailable

application/json
  • codestring
  • correlation_idstring
  • messagestring
Examplejson
{
  "code": "string",
  "correlation_id": "string",
  "message": "string"
}