{ "opencollection": "1.0.0", "info": { "name": "Didomi consents/events metadata API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "metadata", "type": "folder" }, "items": [ { "info": { "name": "POST /metadata/partners/deprecate", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/partners/deprecate", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new resource with data." }, { "info": { "name": "Retrieve a list of vendors", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/vendors", "params": [ { "name": "url", "value": "", "type": "query", "description": "An URL to match to a vendor. This parameter can be repeated multiple times to identify multiple vendors at once." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a list of vendors" }, { "info": { "name": "Create a vendor", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/vendors", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new vendor" }, { "info": { "name": "Retrieve a vendor", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/vendors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the vendor to retrieve" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a single vendor with the given ID" }, { "info": { "name": "Update a vendor", "type": "http" }, "http": { "method": "PUT", "url": "https://api.didomi.io/v1/metadata/vendors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the vendor to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing vendor" }, { "info": { "name": "Patch a vendor", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.didomi.io/v1/metadata/vendors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the vendor to patch" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a vendor" }, { "info": { "name": "Delete a vendor", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.didomi.io/v1/metadata/vendors/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the vendor to delete" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete the vendor" }, { "info": { "name": "Retrieve a list of partners categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-categories", "params": [ { "name": "$limit", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip" }, { "name": "$sort", "value": "", "type": "query", "description": "Property to sort results" }, { "name": "filter", "value": "", "type": "query", "description": "Query parameters to filter" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a list of all partners categories" }, { "info": { "name": "Create a partners category", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/partners-categories", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new partners category" }, { "info": { "name": "Retrieve a partners category", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the partners category to retrieve" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a single partners category with the given ID" }, { "info": { "name": "Update a partners category", "type": "http" }, "http": { "method": "PUT", "url": "https://api.didomi.io/v1/metadata/partners-categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the partners category to update" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing partners category and replace all its properties" }, { "info": { "name": "Patch a partners category", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.didomi.io/v1/metadata/partners-categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the partners category to patch" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Partially update a partners category" }, { "info": { "name": "Delete a partners category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.didomi.io/v1/metadata/partners-categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the partners category to delete" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an existing partners category" }, { "info": { "name": "List partner-purpose associations", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes", "params": [ { "name": "$limit", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip" }, { "name": "$sort", "value": "", "type": "query", "description": "Property to sort results" }, { "name": "filter", "value": "", "type": "query", "description": "Query parameters to filter" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of partner-purpose associations the user has access to" }, { "info": { "name": "Create a partner-purpose association", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/partners-purposes", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new association between a partner and purpose, optionally scoped to an organization" }, { "info": { "name": "Get a partner-purpose association", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a single partner-purpose association by ID" }, { "info": { "name": "PUT /metadata/partners-purposes/{id}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.didomi.io/v1/metadata/partners-purposes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of partners-purposes to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the resource identified by id using data." }, { "info": { "name": "Update processing rules", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.didomi.io/v1/metadata/partners-purposes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates only the processing rules for an existing partner-purpose association" }, { "info": { "name": "Delete a partner-purpose association", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.didomi.io/v1/metadata/partners-purposes/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Permanently removes a partner-purpose association" }, { "info": { "name": "List template overrides", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides", "params": [ { "name": "$limit", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip" }, { "name": "$sort", "value": "", "type": "query", "description": "Property to sort results" }, { "name": "filter", "value": "", "type": "query", "description": "Query parameters to filter" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of template overrides" }, { "info": { "name": "Create a template override", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new template override for a partner-purpose association" }, { "info": { "name": "Get a template override", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a single template override by ID" }, { "info": { "name": "PUT /metadata/partners-purposes-templates-overrides/{id}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of partners-purposes-templates-overrides to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the resource identified by id using data." }, { "info": { "name": "Update a template override", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the processing rule for an existing template override" }, { "info": { "name": "Delete a template override", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.didomi.io/v1/metadata/partners-purposes-templates-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Permanently removes a template override" }, { "info": { "name": "List notice-regulation overrides", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides", "params": [ { "name": "$limit", "value": "", "type": "query", "description": "Number of results to return" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of results to skip" }, { "name": "$sort", "value": "", "type": "query", "description": "Property to sort results" }, { "name": "filter", "value": "", "type": "query", "description": "Query parameters to filter" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of notice-regulation overrides" }, { "info": { "name": "Create a notice-regulation override", "type": "http" }, "http": { "method": "POST", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new notice-regulation override for a partner-purpose association" }, { "info": { "name": "Get a notice-regulation override", "type": "http" }, "http": { "method": "GET", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a single notice-regulation override by ID" }, { "info": { "name": "PUT /metadata/partners-purposes-notices-regulations-overrides/{id}", "type": "http" }, "http": { "method": "PUT", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of partners-purposes-notices-regulations-overrides to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the resource identified by id using data." }, { "info": { "name": "Update a notice-regulation override", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates the processing rule for an existing notice-regulation override" }, { "info": { "name": "Delete a notice-regulation override", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.didomi.io/v1/metadata/partners-purposes-notices-regulations-overrides/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Permanently removes a notice-regulation override" } ] } ], "bundled": true }