List all profiles

Lists all DLP profiles in an account.

/accounts/{account_identifier}/dlp/profiles

get

DLP Profiles

dlp-profiles-list-all-profiles

Debug "planAvailability"

null

Debug "tokenPermissions"

null

Debug "parameters"

[
  {
    "in": "path",
    "name": "account_identifier",
    "required": true,
    "schema": {
      "description": "Identifier",
      "example": "023e105f4ecef8ad9ca31a8372d0c353",
      "maxLength": 32,
      "readOnly": true,
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "properties": {
                    "errors": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "messages": {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    },
                    "result": {
                      "anyOf": [
                        {
                          "type": "object"
                        },
                        {
                          "items": {},
                          "type": "array"
                        },
                        {
                          "type": "string"
                        }
                      ]
                    },
                    "success": {
                      "description": "Whether the API call was successful",
                      "enum": [
                        true
                      ],
                      "example": true,
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "success",
                    "errors",
                    "messages",
                    "result"
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "items": {},
                      "nullable": true,
                      "type": "array"
                    },
                    "result_info": {
                      "properties": {
                        "count": {
                          "description": "Total number of results for the requested service",
                          "example": 1,
                          "type": "number"
                        },
                        "page": {
                          "description": "Current page within paginated list of results",
                          "example": 1,
                          "type": "number"
                        },
                        "per_page": {
                          "description": "Number of results per page of results",
                          "example": 20,
                          "type": "number"
                        },
                        "total_count": {
                          "description": "Total results available without any search parameters",
                          "example": 2000,
                          "type": "number"
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              ],
              "type": "object"
            },
            {
              "properties": {
                "result": {
                  "items": {
                    "anyOf": [
                      {
                        "properties": {
                          "allowed_match_count": {
                            "default": 0,
                            "description": "Related DLP policies will trigger when the match count exceeds the number set.",
                            "example": 5,
                            "maximum": 1000,
                            "minimum": 0,
                            "type": "number"
                          },
                          "entries": {
                            "description": "The entries for this profile.",
                            "items": {
                              "description": "A predefined entry that matches a profile",
                              "properties": {
                                "enabled": {
                                  "description": "Whether the entry is enabled or not.",
                                  "example": true,
                                  "type": "boolean"
                                },
                                "id": {
                                  "allOf": [
                                    {
                                      "description": "UUID",
                                      "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                      "maxLength": 36,
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  ],
                                  "description": "The ID for this entry",
                                  "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                },
                                "name": {
                                  "description": "The name of the entry.",
                                  "example": "Credit card (Visa)",
                                  "type": "string"
                                },
                                "profile_id": {
                                  "description": "ID of the parent profile"
                                }
                              },
                              "title": "Predefined entry",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "id": {
                            "allOf": [
                              {
                                "description": "UUID",
                                "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                "maxLength": 36,
                                "readOnly": true,
                                "type": "string"
                              }
                            ],
                            "description": "The ID for this profile",
                            "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                          },
                          "name": {
                            "description": "The name of the profile.",
                            "example": "Generic CVV Card Number",
                            "type": "string"
                          },
                          "type": {
                            "description": "The type of the profile.",
                            "enum": [
                              "predefined"
                            ],
                            "example": "predefined",
                            "type": "string"
                          }
                        },
                        "title": "Predefined profile",
                        "type": "object"
                      },
                      {
                        "properties": {
                          "allowed_match_count": {
                            "default": 0,
                            "description": "Related DLP policies will trigger when the match count exceeds the number set.",
                            "example": 5,
                            "maximum": 1000,
                            "minimum": 0,
                            "type": "number"
                          },
                          "created_at": {
                            "example": "2014-01-01T05:20:00.12345Z",
                            "format": "date-time",
                            "readOnly": true,
                            "type": "string"
                          },
                          "description": {
                            "description": "The description of the profile.",
                            "example": "A standard CVV card number",
                            "type": "string"
                          },
                          "entries": {
                            "description": "The entries for this profile.",
                            "items": {
                              "description": "A custom entry that matches a profile",
                              "properties": {
                                "created_at": {
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "readOnly": true,
                                  "type": "string"
                                },
                                "enabled": {
                                  "description": "Whether the entry is enabled or not.",
                                  "example": true,
                                  "type": "boolean"
                                },
                                "id": {
                                  "allOf": [
                                    {
                                      "description": "UUID",
                                      "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                      "maxLength": 36,
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  ],
                                  "description": "The ID for this entry",
                                  "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                },
                                "name": {
                                  "description": "The name of the entry.",
                                  "example": "Credit card (Visa)",
                                  "type": "string"
                                },
                                "pattern": {
                                  "description": "A pattern that matches an entry",
                                  "properties": {
                                    "regex": {
                                      "description": "The regex pattern.",
                                      "example": "^4[0-9]{6,14}$",
                                      "type": "string"
                                    },
                                    "validation": {
                                      "description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.",
                                      "enum": [
                                        "luhn"
                                      ],
                                      "example": "luhn",
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "regex"
                                  ],
                                  "title": "Pattern",
                                  "type": "object"
                                },
                                "profile_id": {
                                  "description": "ID of the parent profile"
                                },
                                "updated_at": {
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "readOnly": true,
                                  "type": "string"
                                }
                              },
                              "title": "Custom entry",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "id": {
                            "allOf": [
                              {
                                "description": "UUID",
                                "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                "maxLength": 36,
                                "readOnly": true,
                                "type": "string"
                              }
                            ],
                            "description": "The ID for this profile",
                            "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                          },
                          "name": {
                            "description": "The name of the profile.",
                            "example": "Generic CVV Card Number",
                            "type": "string"
                          },
                          "type": {
                            "description": "The type of the profile.",
                            "enum": [
                              "custom"
                            ],
                            "example": "custom",
                            "type": "string"
                          },
                          "updated_at": {
                            "example": "2014-01-01T05:20:00.12345Z",
                            "format": "date-time",
                            "readOnly": true,
                            "type": "string"
                          }
                        },
                        "title": "Custom profile",
                        "type": "object"
                      },
                      {
                        "properties": {
                          "created_at": {
                            "example": "2014-01-01T05:20:00.12345Z",
                            "format": "date-time",
                            "readOnly": true,
                            "type": "string"
                          },
                          "description": {
                            "description": "The description of the profile.",
                            "type": "string"
                          },
                          "entries": {
                            "description": "The entries for this profile.",
                            "items": {
                              "description": "An entry derived from an integration",
                              "properties": {
                                "created_at": {
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "readOnly": true,
                                  "type": "string"
                                },
                                "enabled": {
                                  "description": "Whether the entry is enabled or not.",
                                  "example": true,
                                  "type": "boolean"
                                },
                                "id": {
                                  "allOf": [
                                    {
                                      "description": "UUID",
                                      "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                      "maxLength": 36,
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  ],
                                  "description": "The ID for this entry",
                                  "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                },
                                "name": {
                                  "description": "The name of the entry.",
                                  "example": "Top Secret",
                                  "type": "string"
                                },
                                "profile_id": {
                                  "description": "ID of the parent profile"
                                },
                                "updated_at": {
                                  "example": "2014-01-01T05:20:00.12345Z",
                                  "format": "date-time",
                                  "readOnly": true,
                                  "type": "string"
                                }
                              },
                              "title": "Integration entry",
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "id": {
                            "allOf": [
                              {
                                "description": "UUID",
                                "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                "maxLength": 36,
                                "readOnly": true,
                                "type": "string"
                              }
                            ],
                            "description": "The ID for this profile",
                            "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                          },
                          "name": {
                            "description": "The name of the profile.",
                            "example": "MIP Sensitivity Labels: Profile 1",
                            "type": "string"
                          },
                          "type": {
                            "description": "The type of the profile.",
                            "enum": [
                              "integration"
                            ],
                            "example": "integration",
                            "type": "string"
                          },
                          "updated_at": {
                            "example": "2014-01-01T05:20:00.12345Z",
                            "format": "date-time",
                            "readOnly": true,
                            "type": "string"
                          }
                        },
                        "title": "Integration profile",
                        "type": "object"
                      }
                    ]
                  },
                  "type": "array"
                }
              }
            }
          ]
        }
      }
    },
    "description": "List all profiles response"
  },
  "4XX": {
    "content": {
      "application/json": {
        "schema": {
          "allOf": [
            {
              "allOf": [
                {
                  "allOf": [
                    {
                      "properties": {
                        "errors": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "messages": {
                          "example": [],
                          "items": {
                            "properties": {
                              "code": {
                                "minimum": 1000,
                                "type": "integer"
                              },
                              "message": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "code",
                              "message"
                            ],
                            "type": "object",
                            "uniqueItems": true
                          },
                          "type": "array"
                        },
                        "result": {
                          "anyOf": [
                            {
                              "type": "object"
                            },
                            {
                              "items": {},
                              "type": "array"
                            },
                            {
                              "type": "string"
                            }
                          ]
                        },
                        "success": {
                          "description": "Whether the API call was successful",
                          "enum": [
                            true
                          ],
                          "example": true,
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "success",
                        "errors",
                        "messages",
                        "result"
                      ],
                      "type": "object"
                    },
                    {
                      "properties": {
                        "result": {
                          "items": {},
                          "nullable": true,
                          "type": "array"
                        },
                        "result_info": {
                          "properties": {
                            "count": {
                              "description": "Total number of results for the requested service",
                              "example": 1,
                              "type": "number"
                            },
                            "page": {
                              "description": "Current page within paginated list of results",
                              "example": 1,
                              "type": "number"
                            },
                            "per_page": {
                              "description": "Number of results per page of results",
                              "example": 20,
                              "type": "number"
                            },
                            "total_count": {
                              "description": "Total results available without any search parameters",
                              "example": 2000,
                              "type": "number"
                            }
                          },
                          "type": "object"
                        }
                      }
                    }
                  ],
                  "type": "object"
                },
                {
                  "properties": {
                    "result": {
                      "items": {
                        "anyOf": [
                          {
                            "properties": {
                              "allowed_match_count": {
                                "default": 0,
                                "description": "Related DLP policies will trigger when the match count exceeds the number set.",
                                "example": 5,
                                "maximum": 1000,
                                "minimum": 0,
                                "type": "number"
                              },
                              "entries": {
                                "description": "The entries for this profile.",
                                "items": {
                                  "description": "A predefined entry that matches a profile",
                                  "properties": {
                                    "enabled": {
                                      "description": "Whether the entry is enabled or not.",
                                      "example": true,
                                      "type": "boolean"
                                    },
                                    "id": {
                                      "allOf": [
                                        {
                                          "description": "UUID",
                                          "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                          "maxLength": 36,
                                          "readOnly": true,
                                          "type": "string"
                                        }
                                      ],
                                      "description": "The ID for this entry",
                                      "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                    },
                                    "name": {
                                      "description": "The name of the entry.",
                                      "example": "Credit card (Visa)",
                                      "type": "string"
                                    },
                                    "profile_id": {
                                      "description": "ID of the parent profile"
                                    }
                                  },
                                  "title": "Predefined entry",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "id": {
                                "allOf": [
                                  {
                                    "description": "UUID",
                                    "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                    "maxLength": 36,
                                    "readOnly": true,
                                    "type": "string"
                                  }
                                ],
                                "description": "The ID for this profile",
                                "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                              },
                              "name": {
                                "description": "The name of the profile.",
                                "example": "Generic CVV Card Number",
                                "type": "string"
                              },
                              "type": {
                                "description": "The type of the profile.",
                                "enum": [
                                  "predefined"
                                ],
                                "example": "predefined",
                                "type": "string"
                              }
                            },
                            "title": "Predefined profile",
                            "type": "object"
                          },
                          {
                            "properties": {
                              "allowed_match_count": {
                                "default": 0,
                                "description": "Related DLP policies will trigger when the match count exceeds the number set.",
                                "example": 5,
                                "maximum": 1000,
                                "minimum": 0,
                                "type": "number"
                              },
                              "created_at": {
                                "example": "2014-01-01T05:20:00.12345Z",
                                "format": "date-time",
                                "readOnly": true,
                                "type": "string"
                              },
                              "description": {
                                "description": "The description of the profile.",
                                "example": "A standard CVV card number",
                                "type": "string"
                              },
                              "entries": {
                                "description": "The entries for this profile.",
                                "items": {
                                  "description": "A custom entry that matches a profile",
                                  "properties": {
                                    "created_at": {
                                      "example": "2014-01-01T05:20:00.12345Z",
                                      "format": "date-time",
                                      "readOnly": true,
                                      "type": "string"
                                    },
                                    "enabled": {
                                      "description": "Whether the entry is enabled or not.",
                                      "example": true,
                                      "type": "boolean"
                                    },
                                    "id": {
                                      "allOf": [
                                        {
                                          "description": "UUID",
                                          "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                          "maxLength": 36,
                                          "readOnly": true,
                                          "type": "string"
                                        }
                                      ],
                                      "description": "The ID for this entry",
                                      "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                    },
                                    "name": {
                                      "description": "The name of the entry.",
                                      "example": "Credit card (Visa)",
                                      "type": "string"
                                    },
                                    "pattern": {
                                      "description": "A pattern that matches an entry",
                                      "properties": {
                                        "regex": {
                                          "description": "The regex pattern.",
                                          "example": "^4[0-9]{6,14}$",
                                          "type": "string"
                                        },
                                        "validation": {
                                          "description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.",
                                          "enum": [
                                            "luhn"
                                          ],
                                          "example": "luhn",
                                          "type": "string"
                                        }
                                      },
                                      "required": [
                                        "regex"
                                      ],
                                      "title": "Pattern",
                                      "type": "object"
                                    },
                                    "profile_id": {
                                      "description": "ID of the parent profile"
                                    },
                                    "updated_at": {
                                      "example": "2014-01-01T05:20:00.12345Z",
                                      "format": "date-time",
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  },
                                  "title": "Custom entry",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "id": {
                                "allOf": [
                                  {
                                    "description": "UUID",
                                    "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                    "maxLength": 36,
                                    "readOnly": true,
                                    "type": "string"
                                  }
                                ],
                                "description": "The ID for this profile",
                                "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                              },
                              "name": {
                                "description": "The name of the profile.",
                                "example": "Generic CVV Card Number",
                                "type": "string"
                              },
                              "type": {
                                "description": "The type of the profile.",
                                "enum": [
                                  "custom"
                                ],
                                "example": "custom",
                                "type": "string"
                              },
                              "updated_at": {
                                "example": "2014-01-01T05:20:00.12345Z",
                                "format": "date-time",
                                "readOnly": true,
                                "type": "string"
                              }
                            },
                            "title": "Custom profile",
                            "type": "object"
                          },
                          {
                            "properties": {
                              "created_at": {
                                "example": "2014-01-01T05:20:00.12345Z",
                                "format": "date-time",
                                "readOnly": true,
                                "type": "string"
                              },
                              "description": {
                                "description": "The description of the profile.",
                                "type": "string"
                              },
                              "entries": {
                                "description": "The entries for this profile.",
                                "items": {
                                  "description": "An entry derived from an integration",
                                  "properties": {
                                    "created_at": {
                                      "example": "2014-01-01T05:20:00.12345Z",
                                      "format": "date-time",
                                      "readOnly": true,
                                      "type": "string"
                                    },
                                    "enabled": {
                                      "description": "Whether the entry is enabled or not.",
                                      "example": true,
                                      "type": "boolean"
                                    },
                                    "id": {
                                      "allOf": [
                                        {
                                          "description": "UUID",
                                          "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                          "maxLength": 36,
                                          "readOnly": true,
                                          "type": "string"
                                        }
                                      ],
                                      "description": "The ID for this entry",
                                      "example": "719d1215-260f-41d0-8c32-eb320ad107f7"
                                    },
                                    "name": {
                                      "description": "The name of the entry.",
                                      "example": "Top Secret",
                                      "type": "string"
                                    },
                                    "profile_id": {
                                      "description": "ID of the parent profile"
                                    },
                                    "updated_at": {
                                      "example": "2014-01-01T05:20:00.12345Z",
                                      "format": "date-time",
                                      "readOnly": true,
                                      "type": "string"
                                    }
                                  },
                                  "title": "Integration entry",
                                  "type": "object"
                                },
                                "type": "array"
                              },
                              "id": {
                                "allOf": [
                                  {
                                    "description": "UUID",
                                    "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
                                    "maxLength": 36,
                                    "readOnly": true,
                                    "type": "string"
                                  }
                                ],
                                "description": "The ID for this profile",
                                "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
                              },
                              "name": {
                                "description": "The name of the profile.",
                                "example": "MIP Sensitivity Labels: Profile 1",
                                "type": "string"
                              },
                              "type": {
                                "description": "The type of the profile.",
                                "enum": [
                                  "integration"
                                ],
                                "example": "integration",
                                "type": "string"
                              },
                              "updated_at": {
                                "example": "2014-01-01T05:20:00.12345Z",
                                "format": "date-time",
                                "readOnly": true,
                                "type": "string"
                              }
                            },
                            "title": "Integration profile",
                            "type": "object"
                          }
                        ]
                      },
                      "type": "array"
                    }
                  }
                }
              ]
            },
            {
              "properties": {
                "errors": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": [
                    {
                      "code": 7003,
                      "message": "No route for the URI"
                    }
                  ],
                  "minLength": 1
                },
                "messages": {
                  "allOf": [
                    {
                      "example": [],
                      "items": {
                        "properties": {
                          "code": {
                            "minimum": 1000,
                            "type": "integer"
                          },
                          "message": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object",
                        "uniqueItems": true
                      },
                      "type": "array"
                    }
                  ],
                  "example": []
                },
                "result": {
                  "enum": [
                    null
                  ],
                  "nullable": true,
                  "type": "object"
                },
                "success": {
                  "description": "Whether the API call was successful",
                  "enum": [
                    false
                  ],
                  "example": false,
                  "type": "boolean"
                }
              },
              "required": [
                "success",
                "errors",
                "messages",
                "result"
              ],
              "type": "object"
            }
          ]
        }
      }
    },
    "description": "List all profiles response failure"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]