MCP Tools Reference: paydeveloper.googleapis.com

Tool: list_principals

Listet die Hauptkonten (Nutzer) auf, die Zugriff auf einen bestimmten Händler haben. Für diesen Vorgang ist Administratorzugriff für den Händler erforderlich.

Das folgende Codebeispiel zeigt, wie Sie curl verwenden, um das MCP-Tool list_principals aufzurufen.

Curl-Anfrage 
curl --location 'https://paydeveloper.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_principals",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

Anfragenachricht zum Auflisten der Hauptkonten eines Händlers.

ListPrincipalsRequest

JSON-Darstellung 
{
  "merchantId": string
}
Felder
merchantId

string

Erforderlich. Die Händler-ID, für die Hauptkonten aufgelistet werden sollen.

Ausgabeschema

Antwortnachricht zum Auflisten der Hauptkonten eines Händlers.

ListPrincipalsResponse

JSON-Darstellung 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Felder
principals[]

object (Principal)

Die Hauptkonten, die Zugriff auf den Händler haben.

Hauptkonto

JSON-Darstellung 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
Felder
email

string

Erforderlich. Die E-Mail-Adresse des Hauptkontos.
displayName

string

Nur Ausgabe. Der Anzeigename des Hauptkontos.
role

enum (PrincipalRole)

Die Rolle des Hauptkontos für den Händler.
state

enum (State)

Nur Ausgabe. Der Zugriffsstatus des Hauptkontos für den Händler.

PrincipalRole

Eine Rolle, die einem Hauptkonto (Nutzer) für einen Händler gewährt werden kann.

Enums
PRINCIPAL_ROLE_UNSPECIFIED Die Rolle ist nicht angegeben.
ADMIN Vollständiger Zugriff auf den Händler, einschließlich der Verwaltung von Nutzern.
DEVELOPER Zugriff für Entwickler, die eine Integration mit dem Händler vornehmen.

Bundesland

Der Status des Zugriffs eines Hauptkontos auf einen Händler.

Enums
STATE_UNSPECIFIED Der Zugriffsstatus ist nicht angegeben.
ACTIVE Das Hauptkonto hat einen aktiven, akzeptierten Zugriff.
PENDING Das Hauptkonto wurde eingeladen, hat die Einladung aber noch nicht angenommen.
EXPIRED Die Einladung des Hauptkontos ist abgelaufen.

Toolanmerkungen

Toolanmerkungen werden an MCP-Clients gesendet, um das grundlegende Risiko eines bestimmten Tools zu beschreiben. Die meisten Clients behandeln diese Hinweise als nicht vertrauenswürdig, sie können aber verwendet werden, um zu entscheiden, wann eine Bestätigungsaufforderung an einen Nutzer gesendet werden soll.

Neben dem Titelstring sind die folgenden booleschen Hinweise definiert:

  • readOnlyHint: Wenn „true“ (wahr), ändert das Tool seine Umgebung nicht. Standardeinstellung: „false“ (falsch).
  • destructiveHint: Wenn „true“ (wahr), kann das Tool destruktive Aktionen ausführen. Wenn „false“ (falsch), kann das Tool nur additive Aktionen ausführen. Standardeinstellung: „true“ (wahr).
  • idempotentHint: Wenn „true“ (wahr), hat das wiederholte Aufrufen des Tools mit denselben Argumenten keine zusätzlichen Auswirkungen auf seine Umgebung. Standardeinstellung: „false“ (falsch).
  • openWorldHint: Wenn „true“ (wahr), kann das Tool mit einer „offenen Welt“ externer Entitäten interagieren. Wenn „false“ (falsch), kann das Tool nur mit internen Entitäten interagieren. Ein Websuchtool wäre beispielsweise eine offene Welt, ein Speichertool jedoch nicht.

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ✅ | Hinweis „Nur lesen“: ✅ | Hinweis „Offene Welt“: ❌