Utilisateurs

Lister l'inventaire RGPD du sujet délégué

Exige une allowlist explicite sur la clé et la capacité rgpd_inventory.

Scope requis : users:read. Scopes et délégation.

Délégation utilisateur : exactement un header X-Marko-Delegated-User-Id ou X-Marko-Delegated-User-Email.

Accès complémentaire : allowlist utilisateur explicite sur la clé et capacité rgpd_inventory. Le sujet doit être approuvé et appartenir à la même entité.

Export, inventaire et effacement RGPD.

Lister l'inventaire RGPD du sujet délégué

curl --request GET \
  --url https://partner-api.marko.fr/v1/users/me/rgpd/inventory \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/users/me/rgpd/inventory';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/users/me/rgpd/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/users/me/rgpd/inventory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "user_id": "usr_001",
  "auth_database": {
    "user": {
      "table": "example",
      "fields": [],
      "pii_fields": [],
      "has_data": true
    }
  },
  "entity_databases": {
    "scope": "example",
    "entity_slugs": [],
    "warnings": [],
    "tables_with_user_references": [],
    "note": "example",
    "entities": []
  }
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

X-Marko-Delegated-User-Id

string

Fournir exactement un des deux headers de délégation (Id ou Email), dans la même entité. Ils sont mutuellement exclusifs. Voir le guide Scopes et délégation.

X-Marko-Delegated-User-Email

string

Fournir exactement un des deux headers de délégation (Id ou Email), dans la même entité. Ils sont mutuellement exclusifs. Voir le guide Scopes et délégation.

Response

Successful response

user_id

string

required

Identifiant utilisateur MARKO; il n'est pas nécessairement un UUID.

auth_database

object

required

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

Show child attributes

entity_databases

object

required

Résultats des sources de données de l'entité incluses dans l'inventaire ou l'export RGPD.

Show child attributes

⌘I

Lister l'inventaire RGPD du sujet délégué

curl --request GET \
  --url https://partner-api.marko.fr/v1/users/me/rgpd/inventory \
  --header 'Authorization: Bearer <token>'

const url = 'https://partner-api.marko.fr/v1/users/me/rgpd/inventory';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/users/me/rgpd/inventory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/users/me/rgpd/inventory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "user_id": "usr_001",
  "auth_database": {
    "user": {
      "table": "example",
      "fields": [],
      "pii_fields": [],
      "has_data": true
    }
  },
  "entity_databases": {
    "scope": "example",
    "entity_slugs": [],
    "warnings": [],
    "tables_with_user_references": [],
    "note": "example",
    "entities": []
  }
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "type": "about:blank",
  "request_id": "<string>",
  "scope": "<string>",
  "route_id": "<string>",
  "reason_code": "<string>"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Lister l'inventaire RGPD du sujet délégué

Authorizations

Headers

Response