Lister les relations utilisateur

Utilisez cet endpoint pour lister les utilisateurs liés à un objet de données.

Important

Les objets de données sont disponibles pour tous, mais votre espace de travail doit être provisionné pour les comptes avant que vous puissiez utiliser cet endpoint. Pour demander le provisionnement, accédez à Paramètres des données > Comptes et remplissez le questionnaire. Pour plus de détails, consultez Activer les comptes.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API disposant de la permission data_objects.user_relationships.read.

Limite de débit

Cet endpoint fait partie du compartiment de lecture des objets de données, avec une limite par défaut de 1 000 requêtes par minute.

Paramètres de chemin

Le tableau suivant liste et décrit les paramètres de chemin de l’endpoint /data_objects/objects/{type_name}/{object_id}/user_relationships.

Paramètres de requête

Le tableau suivant liste et décrit les paramètres de requête de l’endpoint /data_objects/objects/{type_name}/{object_id}/user_relationships.

Exemple de requête

Cette section comprend un exemple de payload de paramètres et un exemple de requête cURL.

Exemple de payload de requête

Utilisez cet objet JSON comme référence pour les paramètres de requête.

1
2
3
4
5
6
7

{
  "type_name": "account",
  "object_id": "acct-123",
  "rel_kind": "account_user",
  "limit": 100,
  "offset": 0
}

Exemple de requête cURL

Cet exemple liste les utilisateurs liés à acct-123 via la relation account_user.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/user_relationships?rel_kind=account_user&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Réponse

Cette section comprend un exemple de réponse réussie et les champs de la réponse.

Exemple de réponse réussie

Le code de statut 200 peut renvoyer le corps de réponse suivant.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "items": [
    {
      "type_name": "account",
      "object_id": "acct-123",
      "rel_kind": "account_user",
      "user": { "braze_id": "507f1f77bcf86cd799439011" },
      "attributes": { "role": "admin" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

Le payload user contient uniquement braze_id.

Paramètres de réponse

Le tableau suivant liste et décrit les champs d’une réponse réussie.

Erreurs

Le tableau suivant liste les erreurs courantes de cet endpoint et la manière de les résoudre.