MCP Tools Reference: paydeveloper.googleapis.com

Outil : list_principals

Répertorie les comptes principaux (utilisateurs) qui ont accès à un marchand spécifique. Cette opération nécessite un accès administrateur pour le marchand.

L'exemple de code suivant montre comment utiliser curl pour appeler l'outil MCP list_principals.

Requête curl 
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
}'

Schéma d'entrée

Message de requête pour la liste des comptes principaux d'un marchand.

ListPrincipalsRequest

Représentation JSON 
{
  "merchantId": string
}
Champs
merchantId

string

Obligatoire. ID du marchand pour lequel lister les comptes principaux.

Schéma de sortie

Message de réponse pour la liste des comptes principaux d'un marchand.

ListPrincipalsResponse

Représentation JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Champs
principals[]

object (Principal)

Comptes principaux ayant accès au marchand.

Principal

Représentation JSON 
{
  "email": string,
  "displayName": string,
  "role": enum (PrincipalRole),
  "state": enum (State)
}
Champs
email

string

Obligatoire. Adresse e-mail du compte principal.
displayName

string

Uniquement en sortie. Nom à afficher du compte principal.
role

enum (PrincipalRole)

Rôle du compte principal pour le marchand.
state

enum (State)

Uniquement en sortie. État d'accès du compte principal pour le marchand.

PrincipalRole

Rôle pouvant être accordé à un compte principal (utilisateur) pour un marchand.

Enums
PRINCIPAL_ROLE_UNSPECIFIED Le rôle n'est pas spécifié.
ADMIN Accès complet au marchand, y compris pour gérer les utilisateurs.
DEVELOPER Accès destiné aux développeurs qui s'intègrent au marchand.

État

État d'accès d'un compte principal pour un marchand.

Enums
STATE_UNSPECIFIED L'état d'accès n'est pas spécifié.
ACTIVE Le compte principal dispose d'un accès actif et accepté.
PENDING Le compte principal a été invité, mais n'a pas encore accepté l'invitation.
EXPIRED L'invitation du compte principal a expiré.

Annotations d'outil

Les annotations d'outil sont envoyées aux clients MCP pour décrire le risque de base d'un outil donné. La plupart des clients traitent ces indications comme non fiables, mais elles peuvent être utilisées pour déterminer quand une invite de confirmation peut être envoyée à un utilisateur.

Outre la chaîne de titre, les indications booléennes suivantes sont définies comme suit :

  • readOnlyHint : si la valeur est "true", l'outil ne modifie pas son environnement. Valeur par défaut : "false".
  • destructiveHint : si la valeur est "true", l'outil peut effectuer des actions destructrices. Si la valeur est "false", l'outil ne peut effectuer que des actions additives. Valeur par défaut : "true".
  • idempotentHint : si la valeur est "true", l'appel répété de l'outil avec les mêmes arguments n'aura aucun effet supplémentaire sur son environnement. Valeur par défaut : "false".
  • openWorldHint : si la valeur est "true", l'outil peut interagir avec un "monde ouvert" d'entités externes. Si la valeur est "false", l'outil ne peut interagir qu'avec des entités internes. Par exemple, un outil de recherche sur le Web serait en monde ouvert, tandis qu'un outil de mémoire ne le serait pas.

Indication destructive : ❌ | Indication idempotente : ✅ | Indication en lecture seule : ✅ | Indication de monde ouvert : ❌