{"items":[{"type":"link","label":"Push Security REST API","link":"/rest-v1","routeSlug":"/rest-v1","content":{"contentType":"overview","meta":{"name":"Push Security REST API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"rest-v1.json","url":"/help/audience/engineering/_bundle/rest-v1.json?download"},{"kind":"download","label":"rest-v1.yaml","url":"/help/audience/engineering/_bundle/rest-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://pushsecurity.com/contact/","url":"https://pushsecurity.com/contact/"},{"kind":"email","title":"support","email":"support@pushsecurity.com","label":"support@pushsecurity.com","withCopyButton":true,"copyContent":"support@pushsecurity.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Commercial","url":"https://pushsecurity.com/legal/terms/"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://pushsecurity.com/legal/terms/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"python","title":"Python","lang":"Python"},{"key":"node","title":"Node.js","lang":"Node.js"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.pushsecurity.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Push Security REST API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/rest-v1"}],"sectionId":"/rest-v1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Push Security REST API provides programmatic access to the administrative functionality of the Push platform. This API adheres to RESTful principles, featuring resource-oriented URLs that are predictable and easy to navigate."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API uses JSON-formatted request bodies and responses along with standard HTTP response codes, authentication methods, and HTTP verbs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#section/Rate-limits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are in place to ensure consistent performance for all users."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To interact with the Push Security API, you'll need an API key for authentication. To create or manage your API keys, go to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://console.pushsecurity.com/app/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page in the Push admin console."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When generating a new key, you have two permission levels to choose from: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Read only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Full access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Read only"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key lets you make GET requests, while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Full access"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allows for all types of requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To authenticate your API requests, include a header named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-api-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and set its value to your API key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API calls must be made over HTTPS."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Push Security API enforces rate limiting to ensure equitable access and maintain performance. Each user is permitted up to 10 API requests per second, with a temporary burst capacity that allows an additional 10 requests for brief intervals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you surpass these limits, the API will return a 429 status code as an indication."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-size"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response size"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses are limited to 1MB. A request to a list endpoint that would return more than 1MB of data is rejected with a 422 status code and the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESULT_SIZE_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter and make the request again."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/response-size"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Push Security API uses standard HTTP response codes to signal the outcome of an API call. Here's what you need to know:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2xx codes: These indicate that your request was successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4xx codes: A client-side issue, usually because something is missing or incorrect in your request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"5xx codes: These suggest a problem on our end, although these occurrences are infrequent."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/common-response-codes"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common Response Codes"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Code"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"200 OK"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request was successfully processed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your request is missing something or is incorrect. Double-check your parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"422 Unprocessable Content"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You've exceeded the rate limits. Consider implementing exponential backoffs in your API calls."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Server Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Something's not right on our end."},"children":[]}]}]}]}]}]}]}],"sectionId":"/rest-v1/section/common-response-codes"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You're currently working with version 1 of the Push Security API. Should there be any breaking changes in the future, we'll bump up the API version number. If you hold an active API key, we'll send you notifications over email about the deprecation date for the older version."},"children":[]}]}]}]}],"sectionId":"/rest-v1/section/versioning"}]}]}},{"type":"link","label":"Overview","link":"/rest-v1/section/overview","routeSlug":"/rest-v1/section/overview","content":null},{"type":"link","label":"Authentication","link":"/rest-v1/section/authentication","routeSlug":"/rest-v1/section/authentication","content":null},{"type":"link","label":"Rate limits","link":"/rest-v1/section/rate-limits","routeSlug":"/rest-v1/section/rate-limits","content":null},{"type":"link","label":"Response size","link":"/rest-v1/section/response-size","routeSlug":"/rest-v1/section/response-size","content":null},{"type":"link","label":"Errors","link":"/rest-v1/section/errors","routeSlug":"/rest-v1/section/errors","content":null},{"type":"link","label":"Common Response Codes","link":"/rest-v1/section/common-response-codes","routeSlug":"/rest-v1/section/common-response-codes","content":null},{"type":"link","label":"Versioning","link":"/rest-v1/section/versioning","routeSlug":"/rest-v1/section/versioning","content":null},{"type":"separator","label":"Entities","content":null},{"type":"group","label":"Accounts","link":"/rest-v1/accounts","routeSlug":"/rest-v1/accounts","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts/get-accounts","routeSlug":"/rest-v1/accounts/get-accounts","metadata":{"seo":{"title":"List accounts","description":"List accounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-accounts","name":"List accounts","isWebhook":false,"pointer":"/paths/~1v1~1accounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_439","description":"Filter by email address. Accepts partial email addresses for wildcard searches."},{"name":"appType","in":"query","schemaId":"schema_439","description":"Filter by the app associated with this account."},{"name":"employeeId","in":"query","schemaId":"schema_439","description":"Filter by an employee ID associated with this account."},{"name":"passwordId","in":"query","schemaId":"schema_439","description":"Filter by a password ID associated with this account."},{"name":"lastUsedTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the account was last used by an employee - start time. This is a UNIX timestamp (in seconds)."},{"name":"lastUsedTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the account was last used by an employee - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_439"},{"name":"appType","in":"query","schemaId":"schema_439"},{"name":"employeeId","in":"query","schemaId":"schema_439"},{"name":"passwordId","in":"query","schemaId":"schema_439"},{"name":"lastUsedTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"lastUsedTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/accounts","href":"accounts/get-accounts","openApiOperationId":"get-accounts","summary":"List accounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get-accounts"}],"panels":[]}]},"httpPath":"/v1/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts/get-accounts-id","routeSlug":"/rest-v1/accounts/get-accounts-id","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieve an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-accounts-id","name":"Retrieve an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the account","required":true}],"pointer":"/paths/~1v1~1accounts~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/accounts/{id}","href":"accounts/get-accounts-id","openApiOperationId":"get-accounts-id","summary":"Retrieve an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}},"schemaId":"components/schemas/Account","headers":{}},{"code":"400","description":"Bad Request"},{"code":"404","description":"Account Not Found"}],"pointer":"/paths/~1v1~1accounts~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get-accounts-id"}],"panels":[]}]},"httpPath":"/v1/accounts/{id}"},{"label":"Forget an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts/delete-accounts-id","routeSlug":"/rest-v1/accounts/delete-accounts-id","metadata":{"seo":{"title":"Forget an account","description":"Forget an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-accounts-id","name":"Forget an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forget an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the account","required":true}],"pointer":"/paths/~1v1~1accounts~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounts/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/accounts/{id}","href":"accounts/delete-accounts-id","openApiOperationId":"delete-accounts-id","summary":"Forget an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAccount"}},"schemaId":"components/schemas/DeleteAccount"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Account Not Found"}],"pointer":"/paths/~1v1~1accounts~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteAccount"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/delete-accounts-id"}],"panels":[]}]},"httpPath":"/v1/accounts/{id}"},{"label":"Delete a login method from an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts/delete-accounts-id-login-methods","routeSlug":"/rest-v1/accounts/delete-accounts-id-login-methods","metadata":{"seo":{"title":"Delete a login method from an account","description":"Delete a login method from an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-accounts-id-login-methods","name":"Delete a login method from an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{id}~1loginMethods/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a login method from an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the account","required":true}],"pointer":"/paths/~1v1~1accounts~1{id}~1loginMethods/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_443"}},"schemaId":"schema_443","pointer":"/paths/~1v1~1accounts~1{id}~1loginMethods/delete/requestBody","description":"Delete one of the login methods from the account."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/accounts/{id}/loginMethods","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_443"}},"responseCodes":["200","400"],"pointer":"/v1/accounts/{id}/loginMethods","href":"accounts/delete-accounts-id-login-methods","openApiOperationId":"delete-accounts-id-login-methods","summary":"Delete a login method from an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_443","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_443"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}},"schemaId":"components/schemas/Account","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1accounts~1{id}~1loginMethods/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Account","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Account"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/delete-accounts-id-login-methods"}],"panels":[]}]},"httpPath":"/v1/accounts/{id}/loginMethods"},{"label":"List all employees who are using an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts/get-accounts-id-used-by","routeSlug":"/rest-v1/accounts/get-accounts-id-used-by","metadata":{"seo":{"title":"List all employees who are using an account","description":"List all employees who are using an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-accounts-id-used-by","name":"List all employees who are using an account","isWebhook":false,"pointer":"/paths/~1v1~1accounts~1{id}~1usedBy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all employees who are using an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the account","required":true}],"pointer":"/paths/~1v1~1accounts~1{id}~1usedBy/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{id}~1usedBy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accounts/{id}/usedBy","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_441"},{"name":"offset","in":"query","required":false,"schemaId":"schema_440"},{"name":"nextToken","in":"query","required":false,"schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/accounts/{id}/usedBy","href":"accounts/get-accounts-id-used-by","openApiOperationId":"get-accounts-id-used-by","summary":"List all employees who are using an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444","headers":{}},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accounts~1{id}~1usedBy/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts/get-accounts-id-used-by"}],"panels":[]}]},"httpPath":"/v1/accounts/{id}/usedBy"}],"content":{"contentType":"group","meta":{"name":"Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the accounts (owned by employees) in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accounts","summary":"List accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get-accounts","deprecated":false},{"title":"/v1/accounts/{id}","summary":"Retrieve an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get-accounts-id","deprecated":false},{"title":"/v1/accounts/{id}","summary":"Forget an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounts/delete-accounts-id","deprecated":false},{"title":"/v1/accounts/{id}/loginMethods","summary":"Delete a login method from an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounts/delete-accounts-id-login-methods","deprecated":false},{"title":"/v1/accounts/{id}/usedBy","summary":"List all employees who are using an account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts/get-accounts-id-used-by","deprecated":false}]}]}]}]}},{"type":"group","label":"Accounts (Other)","link":"/rest-v1/accounts-(other)","routeSlug":"/rest-v1/accounts-(other)","items":[{"label":"List accounts (other)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts-(other)/get-accounts-other","routeSlug":"/rest-v1/accounts-(other)/get-accounts-other","metadata":{"seo":{"title":"List accounts (other)","description":"List accounts (other)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-accounts-other","name":"List accounts (other)","isWebhook":false,"pointer":"/paths/~1v1~1accountsOther/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounts (other)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_439","description":"Filter by email address. Accepts partial email addresses for wildcard searches."},{"name":"otherAppId","in":"query","schemaId":"schema_439","description":"Filter by other app ID."},{"name":"employeeId","in":"query","schemaId":"schema_439","description":"Filter by an employee ID associated with this account."},{"name":"lastUsedTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the account was last used by an employee - start time. This is a UNIX timestamp (in seconds)."},{"name":"lastUsedTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the account was last used by an employee - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accountsOther/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accountsOther","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_439"},{"name":"otherAppId","in":"query","schemaId":"schema_439"},{"name":"employeeId","in":"query","schemaId":"schema_439"},{"name":"lastUsedTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"lastUsedTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/accountsOther","href":"accounts-(other)/get-accounts-other","openApiOperationId":"get-accounts-other","summary":"List accounts (other)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1accountsOther/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts-(other)/get-accounts-other"}],"panels":[]}]},"httpPath":"/v1/accountsOther"},{"label":"Retrieve an account (other)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/accounts-(other)/get-accounts-other-id","routeSlug":"/rest-v1/accounts-(other)/get-accounts-other-id","metadata":{"seo":{"title":"Retrieve an account (other)","description":"Retrieve an account (other)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-accounts-other-id","name":"Retrieve an account (other)","isWebhook":false,"pointer":"/paths/~1v1~1accountsOther~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an account (other)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_446","description":"Unique identifier for the account (other) record","required":true}],"pointer":"/paths/~1v1~1accountsOther~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/accountsOther/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_446"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/accountsOther/{id}","href":"accounts-(other)/get-accounts-other-id","openApiOperationId":"get-accounts-other-id","summary":"Retrieve an account (other)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountOther"}},"schemaId":"components/schemas/AccountOther","headers":{}},{"code":"400","description":"Bad Request"},{"code":"404","description":"Account (Other) Not Found"}],"pointer":"/paths/~1v1~1accountsOther~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountOther","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountOther"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounts-(other)/get-accounts-other-id"}],"panels":[]}]},"httpPath":"/v1/accountsOther/{id}"}],"content":{"contentType":"group","meta":{"name":"Accounts (Other)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounts (Other)","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the accounts (other) (owned by employees) in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/accountsOther","summary":"List accounts (other)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts-(other)/get-accounts-other","deprecated":false},{"title":"/v1/accountsOther/{id}","summary":"Retrieve an account (other)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounts-(other)/get-accounts-other-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Apps","link":"/rest-v1/apps","routeSlug":"/rest-v1/apps","items":[{"label":"List apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps/get-apps","routeSlug":"/rest-v1/apps/get-apps","metadata":{"seo":{"title":"List apps","description":"List apps"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-apps","name":"List apps","isWebhook":false,"pointer":"/paths/~1v1~1apps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List apps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the app was first observed - start time. This is a UNIX timestamp (in seconds)."},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the app was first observed - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1apps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/apps","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/apps","href":"apps/get-apps","openApiOperationId":"get-apps","summary":"List apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1apps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps/get-apps"}],"panels":[]}]},"httpPath":"/v1/apps"},{"label":"Retrieve an app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps/get-apps-id","routeSlug":"/rest-v1/apps/get-apps-id","metadata":{"seo":{"title":"Retrieve an app","description":"Retrieve an app"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-apps-id","name":"Retrieve an app","isWebhook":false,"pointer":"/paths/~1v1~1apps~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an app","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the app","required":true}],"pointer":"/paths/~1v1~1apps~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/apps/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/apps/{id}","href":"apps/get-apps-id","openApiOperationId":"get-apps-id","summary":"Retrieve an app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/App"}},"schemaId":"components/schemas/App","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1apps~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/App","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/App"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps/get-apps-id"}],"panels":[]}]},"httpPath":"/v1/apps/{id}"},{"label":"Update an app","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps/patch-apps-id","routeSlug":"/rest-v1/apps/patch-apps-id","metadata":{"seo":{"title":"Update an app","description":"Update an app"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-apps-id","name":"Update an app","isWebhook":false,"pointer":"/paths/~1v1~1apps~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an app","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the app","required":true}],"pointer":"/paths/~1v1~1apps~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448","pointer":"/paths/~1v1~1apps~1{id}/patch/requestBody","description":"Update an app's approval status, sensitivity level, and/or notes."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/apps/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_448"}},"responseCodes":["200","400"],"pointer":"/v1/apps/{id}","href":"apps/patch-apps-id","openApiOperationId":"patch-apps-id","summary":"Update an app"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_448"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/App"}},"schemaId":"components/schemas/App","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1apps~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/App","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/App"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps/patch-apps-id"}],"panels":[]}]},"httpPath":"/v1/apps/{id}"},{"label":"Add a label to an app.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps/post-apps-id-labels","routeSlug":"/rest-v1/apps/post-apps-id-labels","metadata":{"seo":{"title":"Add a label to an app.","description":"Add a label to an app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-apps-id-labels","name":"Add a label to an app.","isWebhook":false,"pointer":"/paths/~1v1~1apps~1{id}~1labels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a label to an app.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the app","required":true}],"pointer":"/paths/~1v1~1apps~1{id}~1labels/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449","pointer":"/paths/~1v1~1apps~1{id}~1labels/post/requestBody","description":"Add a label to an app."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/apps/{id}/labels","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_449"}},"responseCodes":["200","400","404"],"pointer":"/v1/apps/{id}/labels","href":"apps/post-apps-id-labels","openApiOperationId":"post-apps-id-labels","summary":"Add a label to an app."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_449"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns all labels associated with the app.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450"},{"code":"400","description":"Invalid input"},{"code":"404","description":"App Not Found"}],"pointer":"/paths/~1v1~1apps~1{id}~1labels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_450"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps/post-apps-id-labels"}],"panels":[]}]},"httpPath":"/v1/apps/{id}/labels"},{"label":"Delete a label from an app.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps/delete-apps-id-labels","routeSlug":"/rest-v1/apps/delete-apps-id-labels","metadata":{"seo":{"title":"Delete a label from an app.","description":"Delete a label from an app."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-apps-id-labels","name":"Delete a label from an app.","isWebhook":false,"pointer":"/paths/~1v1~1apps~1{id}~1labels/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a label from an app.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the app","required":true}],"pointer":"/paths/~1v1~1apps~1{id}~1labels/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451","pointer":"/paths/~1v1~1apps~1{id}~1labels/delete/requestBody","description":"Delete a label from an app."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/apps/{id}/labels","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_451"}},"responseCodes":["200","400","404"],"pointer":"/v1/apps/{id}/labels","href":"apps/delete-apps-id-labels","openApiOperationId":"delete-apps-id-labels","summary":"Delete a label from an app."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_451"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns all labels still associated with the app after the label is deleted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452"},{"code":"400","description":"Invalid input"},{"code":"404","description":"The app with the given ID is not found or the given label is not associated with the app."}],"pointer":"/paths/~1v1~1apps~1{id}~1labels/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps/delete-apps-id-labels"}],"panels":[]}]},"httpPath":"/v1/apps/{id}/labels"}],"content":{"contentType":"group","meta":{"name":"Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apps","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the apps that have been found in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/apps","summary":"List apps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apps/get-apps","deprecated":false},{"title":"/v1/apps/{id}","summary":"Retrieve an app","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apps/get-apps-id","deprecated":false},{"title":"/v1/apps/{id}","summary":"Update an app","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/apps/patch-apps-id","deprecated":false},{"title":"/v1/apps/{id}/labels","summary":"Add a label to an app.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apps/post-apps-id-labels","deprecated":false},{"title":"/v1/apps/{id}/labels","summary":"Delete a label from an app.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/apps/delete-apps-id-labels","deprecated":false}]}]}]}]}},{"type":"group","label":"Apps (Other)","link":"/rest-v1/apps-(other)","routeSlug":"/rest-v1/apps-(other)","items":[{"label":"List Apps (Other)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps-(other)/get-apps-other","routeSlug":"/rest-v1/apps-(other)/get-apps-other","metadata":{"seo":{"title":"List Apps (Other)","description":"List Apps (Other)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-apps-other","name":"List Apps (Other)","isWebhook":false,"pointer":"/paths/~1v1~1appsOther/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Apps (Other)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the app was first observed - start time. This is a UNIX timestamp (in seconds)."},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the app was first observed - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1appsOther/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appsOther","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/appsOther","href":"apps-(other)/get-apps-other","openApiOperationId":"get-apps-other","summary":"List Apps (Other)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1appsOther/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps-(other)/get-apps-other"}],"panels":[]}]},"httpPath":"/v1/appsOther"},{"label":"Retrieve an app (other) record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/apps-(other)/get-apps-other-id","routeSlug":"/rest-v1/apps-(other)/get-apps-other-id","metadata":{"seo":{"title":"Retrieve an app (other) record","description":"Retrieve an app (other) record"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-apps-other-id","name":"Retrieve an app (other) record","isWebhook":false,"pointer":"/paths/~1v1~1appsOther~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an app (other) record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the app (other) record","required":true}],"pointer":"/paths/~1v1~1appsOther~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appsOther/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/appsOther/{id}","href":"apps-(other)/get-apps-other-id","openApiOperationId":"get-apps-other-id","summary":"Retrieve an app (other) record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppOther"}},"schemaId":"components/schemas/AppOther","headers":{}},{"code":"400","description":"Bad Request"},{"code":"404","description":"App (Other) Not Found"}],"pointer":"/paths/~1v1~1appsOther~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppOther","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppOther"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apps-(other)/get-apps-other-id"}],"panels":[]}]},"httpPath":"/v1/appsOther/{id}"}],"content":{"contentType":"group","meta":{"name":"Apps (Other)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apps (Other)","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the apps (other) that have been found in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/appsOther","summary":"List Apps (Other)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apps-(other)/get-apps-other","deprecated":false},{"title":"/v1/appsOther/{id}","summary":"Retrieve an app (other) record","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apps-(other)/get-apps-other-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Browsers","link":"/rest-v1/browsers","routeSlug":"/rest-v1/browsers","items":[{"label":"List browsers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/browsers/get-browsers","routeSlug":"/rest-v1/browsers/get-browsers","metadata":{"seo":{"title":"List browsers","description":"Retrieve a list of browser objects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-browsers","name":"List browsers","isWebhook":false,"pointer":"/paths/~1v1~1browsers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List browsers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of browser objects"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"email","in":"query","schemaId":"schema_439","description":"Filter by email address. Accepts partial email addresses for wildcard searches."},{"name":"employeeId","in":"query","schemaId":"schema_439","description":"Filter by employee ID."},{"name":"browser","in":"query","schemaId":"schema_454","description":"Filter by browser name."},{"name":"os","in":"query","schemaId":"schema_455","description":"Filter by operating system name."},{"name":"lastOnlineTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the browser was last used by an employee - start time. This is a UNIX timestamp (in seconds)."},{"name":"lastOnlineTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the browser was last used by an employee - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1browsers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/browsers","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"email","in":"query","schemaId":"schema_439"},{"name":"employeeId","in":"query","schemaId":"schema_439"},{"name":"browser","in":"query","schemaId":"components/schemas/BrowserType"},{"name":"os","in":"query","schemaId":"components/schemas/OSType"},{"name":"lastOnlineTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"lastOnlineTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/browsers","href":"browsers/get-browsers","openApiOperationId":"get-browsers","summary":"List browsers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}},"schemaId":"schema_456"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1browsers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_456","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browsers/get-browsers"}],"panels":[]}]},"httpPath":"/v1/browsers"},{"label":"Retrieve a browser","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/browsers/get-browsers-id","routeSlug":"/rest-v1/browsers/get-browsers-id","metadata":{"seo":{"title":"Retrieve a browser","description":"Retrieve a browser"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-browsers-id","name":"Retrieve a browser","isWebhook":false,"pointer":"/paths/~1v1~1browsers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a browser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the browser","required":true}],"pointer":"/paths/~1v1~1browsers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/browsers/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/browsers/{id}","href":"browsers/get-browsers-id","openApiOperationId":"get-browsers-id","summary":"Retrieve a browser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Browser"}},"schemaId":"components/schemas/Browser","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1browsers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Browser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Browser"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browsers/get-browsers-id"}],"panels":[]}]},"httpPath":"/v1/browsers/{id}"}],"content":{"contentType":"group","meta":{"name":"Browsers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browsers","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the browsers (used by employees) in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/browsers","summary":"List browsers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browsers/get-browsers","deprecated":false},{"title":"/v1/browsers/{id}","summary":"Retrieve a browser","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browsers/get-browsers-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Browser Extensions","link":"/rest-v1/browser-extensions","routeSlug":"/rest-v1/browser-extensions","items":[{"label":"List browser extensions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/browser-extensions/get-browser-extensions","routeSlug":"/rest-v1/browser-extensions/get-browser-extensions","metadata":{"seo":{"title":"List browser extensions","description":"Retrieve a list of browser extension objects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-browser-extensions","name":"List browser extensions","isWebhook":false,"pointer":"/paths/~1v1~1browserExtensions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List browser extensions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of browser extension objects"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"extensionId","in":"query","schemaId":"schema_439","description":"Filter by the ID of the extension"},{"name":"employeeId","in":"query","schemaId":"schema_439","description":"Filter by an employee ID associated with this extension."},{"name":"browserId","in":"query","schemaId":"schema_439","description":"Filter by a browserId associated with this extension."},{"name":"deploymentMode","in":"query","schemaId":"schema_457","description":"Filter by the deployment mode of the extension."},{"name":"permissions","in":"query","schemaId":"schema_458","description":"Filter for browser extensions that have certain permissions."},{"name":"hostPermissions","in":"query","schemaId":"schema_458","description":"Filter for browser extensions that have certain host permission patterns."},{"name":"enabled","in":"query","schemaId":"schema_459","description":"Filter for extension that are enabled or disabled."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1browserExtensions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/browserExtensions","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"extensionId","in":"query","schemaId":"schema_439"},{"name":"employeeId","in":"query","schemaId":"schema_439"},{"name":"browserId","in":"query","schemaId":"schema_439"},{"name":"deploymentMode","in":"query","schemaId":"components/schemas/DeploymentMode"},{"name":"permissions","in":"query","schemaId":"schema_458"},{"name":"hostPermissions","in":"query","schemaId":"schema_458"},{"name":"enabled","in":"query","schemaId":"schema_459"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/browserExtensions","href":"browser-extensions/get-browser-extensions","openApiOperationId":"get-browser-extensions","summary":"List browser extensions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}},"schemaId":"schema_460"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1browserExtensions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_460","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-extensions/get-browser-extensions"}],"panels":[]}]},"httpPath":"/v1/browserExtensions"}],"content":{"contentType":"group","meta":{"name":"Browser Extensions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browser Extensions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/browserExtensions","summary":"List browser extensions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browser-extensions/get-browser-extensions","deprecated":false}]}]}]}]}},{"type":"group","label":"Detections","link":"/rest-v1/detections","routeSlug":"/rest-v1/detections","items":[{"label":"List detections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/detections/get-detections","routeSlug":"/rest-v1/detections/get-detections","metadata":{"seo":{"title":"List detections","description":"Retrieve a list of detection objects"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-detections","name":"List detections","isWebhook":false,"pointer":"/paths/~1v1~1detections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List detections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of detection objects"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_459","description":"Filter by whether the detection has been archived."},{"name":"severity","in":"query","schemaId":"schema_461","description":"Filter by the severity."},{"name":"detectionType","in":"query","schemaId":"schema_462","description":"Filter by the detection type."},{"name":"response","in":"query","schemaId":"schema_463","description":"Filter by the response."},{"name":"classification","in":"query","schemaId":"schema_464","description":"Filter by the classification."},{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440","description":"Filter by when the detection was created - start time. This is a UNIX timestamp (in seconds)."},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the detection was created - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"nextToken","in":"query","schemaId":"schema_439","description":"Used for pagination. Token to be used for the next request."}],"pointer":"/paths/~1v1~1detections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/detections","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"archived","in":"query","schemaId":"schema_459"},{"name":"severity","in":"query","schemaId":"components/schemas/SeverityType"},{"name":"detectionType","in":"query","example":"PHISHING","schemaId":"components/schemas/DetectionType"},{"name":"response","in":"query","schemaId":"components/schemas/ResponseTypeDetection"},{"name":"classification","in":"query","schemaId":"components/schemas/ClassificationType"},{"name":"creationTimestampAfter","in":"query","schemaId":"schema_440"},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/detections","href":"detections/get-detections","openApiOperationId":"get-detections","summary":"List detections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_465"}},"schemaId":"schema_465"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1detections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_465","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_465"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/detections/get-detections"}],"panels":[]}]},"httpPath":"/v1/detections"},{"label":"Retrieve a detection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/detections/get-detections-id","routeSlug":"/rest-v1/detections/get-detections-id","metadata":{"seo":{"title":"Retrieve a detection","description":"Retrieve a detection"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-detections-id","name":"Retrieve a detection","isWebhook":false,"pointer":"/paths/~1v1~1detections~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the detection","required":true}],"pointer":"/paths/~1v1~1detections~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/detections/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/detections/{id}","href":"detections/get-detections-id","openApiOperationId":"get-detections-id","summary":"Retrieve a detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DetectionId"}},"schemaId":"components/schemas/DetectionId","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1detections~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DetectionId","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DetectionId"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/detections/get-detections-id"}],"panels":[]}]},"httpPath":"/v1/detections/{id}"},{"label":"Update a detection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/detections/patch-detections-id","routeSlug":"/rest-v1/detections/patch-detections-id","metadata":{"seo":{"title":"Update a detection","description":"Update a detection"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-detections-id","name":"Update a detection","isWebhook":false,"pointer":"/paths/~1v1~1detections~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the detection","required":true}],"pointer":"/paths/~1v1~1detections~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_466"}},"schemaId":"schema_466","pointer":"/paths/~1v1~1detections~1{id}/patch/requestBody","description":"Update a detection's archive status."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/detections/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_466"}},"responseCodes":["200","400"],"pointer":"/v1/detections/{id}","href":"detections/patch-detections-id","openApiOperationId":"patch-detections-id","summary":"Update a detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_466","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_466"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Detection"}},"schemaId":"components/schemas/Detection","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1detections~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Detection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Detection"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/detections/patch-detections-id"}],"panels":[]}]},"httpPath":"/v1/detections/{id}"}],"content":{"contentType":"group","meta":{"name":"Detections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detections","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/detections","summary":"List detections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/detections/get-detections","deprecated":false},{"title":"/v1/detections/{id}","summary":"Retrieve a detection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/detections/get-detections-id","deprecated":false},{"title":"/v1/detections/{id}","summary":"Update a detection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/detections/patch-detections-id","deprecated":false}]}]}]}]}},{"type":"group","label":"Employees","link":"/rest-v1/employees","routeSlug":"/rest-v1/employees","items":[{"label":"List employees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/get-employees","routeSlug":"/rest-v1/employees/get-employees","metadata":{"seo":{"title":"List employees","description":"List employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-employees","name":"List employees","isWebhook":false,"pointer":"/paths/~1v1~1employees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"chatopsEnabled","in":"query","schemaId":"schema_459","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by whether they have ChatOps enabled"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: this is a legacy value available for use by Push accounts that are using employee ChatOps topics. This value will be removed in a future version of the API, however, no timeline has been set. Push will provide ample notice of deprecation ahead of time, as well as a replacement option."},"children":[]}]}]}]}]},{"name":"licensed","in":"query","schemaId":"schema_459","description":"Filter by whether they are licensed on the Push platform"},{"name":"groups","in":"query","schemaId":"schema_458","description":"Filter by groups the employee is in."},{"name":"email","in":"query","schemaId":"schema_439","description":"Filter by email address. Accepts partial email addresses for wildcard searches."},{"name":"limit","in":"query","schemaId":"schema_467","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1employees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/employees","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"chatopsEnabled","in":"query","schemaId":"schema_459"},{"name":"licensed","in":"query","schemaId":"schema_459"},{"name":"groups","in":"query","schemaId":"schema_458"},{"name":"email","in":"query","schemaId":"schema_439"},{"name":"limit","in":"query","schemaId":"schema_467"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/employees","href":"employees/get-employees","openApiOperationId":"get-employees","summary":"List employees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}},"schemaId":"schema_468"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1employees/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/get-employees"}],"panels":[]}]},"httpPath":"/v1/employees"},{"label":"Add an employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/post-employees","routeSlug":"/rest-v1/employees/post-employees","metadata":{"seo":{"title":"Add an employee","description":"Add an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-employees","name":"Add an employee","isWebhook":false,"pointer":"/paths/~1v1~1employees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"schemaId":"schema_469","pointer":"/paths/~1v1~1employees/post/requestBody","description":"Create a new employee."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/employees","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_469"}},"responseCodes":["200","400"],"pointer":"/v1/employees","href":"employees/post-employees","openApiOperationId":"post-employees","summary":"Add an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_469","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_469"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeInEvent"}},"schemaId":"components/schemas/EmployeeInEvent","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1employees/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmployeeInEvent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmployeeInEvent"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/post-employees"}],"panels":[]}]},"httpPath":"/v1/employees"},{"label":"Retrieve an employee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/get-employees-id","routeSlug":"/rest-v1/employees/get-employees-id","metadata":{"seo":{"title":"Retrieve an employee","description":"Retrieve an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-employees-id","name":"Retrieve an employee","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/employees/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}","href":"employees/get-employees-id","openApiOperationId":"get-employees-id","summary":"Retrieve an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee","headers":{}},{"code":"400","description":"Bad Request"},{"code":"404","description":"Employee Not Found"}],"pointer":"/paths/~1v1~1employees~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/get-employees-id"}],"panels":[]}]},"httpPath":"/v1/employees/{id}"},{"label":"Update an employee","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/patch-employees-id","routeSlug":"/rest-v1/employees/patch-employees-id","metadata":{"seo":{"title":"Update an employee","description":"Update an employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patch-employees-id","name":"Update an employee","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470","pointer":"/paths/~1v1~1employees~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/employees/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_470"}},"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}","href":"employees/patch-employees-id","openApiOperationId":"patch-employees-id","summary":"Update an employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_470"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you unlicense an employee that hasn't got any accounts"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}},"schemaId":"schema_471"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request with status EMPLOYEE_NOT_LICENSED, EXCEEDED_MAX_LICENSED_EMPLOYEES or CHATOPS_NOT_IN_WORKING_STATE"},"children":[]}]}]}]},{"code":"404","description":"Employee Not Found"}],"pointer":"/paths/~1v1~1employees~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_471","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_471"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/patch-employees-id"}],"panels":[]}]},"httpPath":"/v1/employees/{id}"},{"label":"Generate a browser enrollment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/post-employees-id-enrollmentlink","routeSlug":"/rest-v1/employees/post-employees-id-enrollmentlink","metadata":{"seo":{"title":"Generate a browser enrollment link","description":"Generate a browser enrollment link"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-employees-id-enrollmentLink","name":"Generate a browser enrollment link","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}~1enrollmentLink/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a browser enrollment link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}~1enrollmentLink/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/employees/{id}/enrollmentLink","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}/enrollmentLink","href":"employees/post-employees-id-enrollmentlink","openApiOperationId":"post-employees-id-enrollmentLink","summary":"Generate a browser enrollment link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}},"schemaId":"schema_472"},{"code":"400","description":"Bad Request"},{"code":"404","description":"Employee Not Found"}],"pointer":"/paths/~1v1~1employees~1{id}~1enrollmentLink/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/post-employees-id-enrollmentlink"}],"panels":[]}]},"httpPath":"/v1/employees/{id}/enrollmentLink"},{"label":"Add an employee to a group.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/post-employee-id-groups","routeSlug":"/rest-v1/employees/post-employee-id-groups","metadata":{"seo":{"title":"Add an employee to a group.","description":"Add an employee to a group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-employee-id-groups","name":"Add an employee to a group.","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add an employee to a group.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}~1groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_473"}},"schemaId":"schema_473","pointer":"/paths/~1v1~1employees~1{id}~1groups/post/requestBody","description":"Add an employee to a group"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/employees/{id}/groups","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_473"}},"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}/groups","href":"employees/post-employee-id-groups","openApiOperationId":"post-employee-id-groups","summary":"Add an employee to a group."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_473","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_473"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns all groups associated with the employee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Invalid input"},{"code":"404","description":"Employee Not Found"}],"pointer":"/paths/~1v1~1employees~1{id}~1groups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/post-employee-id-groups"}],"panels":[]}]},"httpPath":"/v1/employees/{id}/groups"},{"label":"Delete an employee from a group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/delete-employee-id-groups","routeSlug":"/rest-v1/employees/delete-employee-id-groups","metadata":{"seo":{"title":"Delete an employee from a group","description":"Delete an employee from a group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-employee-id-groups","name":"Delete an employee from a group","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}~1groups/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an employee from a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}~1groups/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_475"}},"schemaId":"schema_475","pointer":"/paths/~1v1~1employees~1{id}~1groups/delete/requestBody","description":"Delete an employee from a group."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/employees/{id}/groups","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_475"}},"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}/groups","href":"employees/delete-employee-id-groups","openApiOperationId":"delete-employee-id-groups","summary":"Delete an employee from a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_475","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_475"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns all groups still associated with the employee after being removed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476"}},"schemaId":"schema_476"},{"code":"400","description":"Invalid input"},{"code":"404","description":"The employee with the given ID is not found or the employee is not a member of the given group."}],"pointer":"/paths/~1v1~1employees~1{id}~1groups/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_476","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_476"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/delete-employee-id-groups"}],"panels":[]}]},"httpPath":"/v1/employees/{id}/groups"},{"label":"Merge employees","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/post-employees-id-merge","routeSlug":"/rest-v1/employees/post-employees-id-merge","metadata":{"seo":{"title":"Merge employees","description":"Merge employees"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-employees-id-merge","name":"Merge employees","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}~1merge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merge employees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}~1merge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_477"}},"schemaId":"schema_477","pointer":"/paths/~1v1~1employees~1{id}~1merge/post/requestBody","description":"Merge a list of employees with the primary one given."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/employees/{id}/merge","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_477"}},"responseCodes":["200","400","404"],"pointer":"/v1/employees/{id}/merge","href":"employees/post-employees-id-merge","openApiOperationId":"post-employees-id-merge","summary":"Merge employees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_477","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_477"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Returns the details of the primary employee.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"Invalid input"},{"code":"404","description":"Employee Not Found"}],"pointer":"/paths/~1v1~1employees~1{id}~1merge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/post-employees-id-merge"}],"panels":[]}]},"httpPath":"/v1/employees/{id}/merge"},{"label":"Unmerge employee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/employees/post-employees-id-unmerge","routeSlug":"/rest-v1/employees/post-employees-id-unmerge","metadata":{"seo":{"title":"Unmerge employee","description":"Unmerge employee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-employees-id-unmerge","name":"Unmerge employee","isWebhook":false,"pointer":"/paths/~1v1~1employees~1{id}~1unmerge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unmerge employee","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the employee","required":true}],"pointer":"/paths/~1v1~1employees~1{id}~1unmerge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478","pointer":"/paths/~1v1~1employees~1{id}~1unmerge/post/requestBody","description":"Unmerge an email address from a target employee"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/employees/{id}/unmerge","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_478"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/employees/{id}/unmerge","href":"employees/post-employees-id-unmerge","openApiOperationId":"post-employees-id-unmerge","summary":"Unmerge employee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_478"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK. Unmerge operation has completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}},"schemaId":"components/schemas/Employee"},{"code":"400","description":"Invalid input"},{"code":"404","description":"Employee Not Found"},{"code":"500","description":"Internal server error"}],"pointer":"/paths/~1v1~1employees~1{id}~1unmerge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Employee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Employee"}}},{"code":"400"},{"code":"404"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/employees/post-employees-id-unmerge"}],"panels":[]}]},"httpPath":"/v1/employees/{id}/unmerge"}],"content":{"contentType":"group","meta":{"name":"Employees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Employees","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the employees in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/employees","summary":"List employees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/get-employees","deprecated":false},{"title":"/v1/employees","summary":"Add an employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/post-employees","deprecated":false},{"title":"/v1/employees/{id}","summary":"Retrieve an employee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/employees/get-employees-id","deprecated":false},{"title":"/v1/employees/{id}","summary":"Update an employee","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/employees/patch-employees-id","deprecated":false},{"title":"/v1/employees/{id}/enrollmentLink","summary":"Generate a browser enrollment link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/post-employees-id-enrollmentlink","deprecated":false},{"title":"/v1/employees/{id}/groups","summary":"Add an employee to a group.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/post-employee-id-groups","deprecated":false},{"title":"/v1/employees/{id}/groups","summary":"Delete an employee from a group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/employees/delete-employee-id-groups","deprecated":false},{"title":"/v1/employees/{id}/merge","summary":"Merge employees","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/post-employees-id-merge","deprecated":false},{"title":"/v1/employees/{id}/unmerge","summary":"Unmerge employee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/employees/post-employees-id-unmerge","deprecated":false}]}]}]}]}},{"type":"group","label":"Findings","link":"/rest-v1/findings","routeSlug":"/rest-v1/findings","items":[{"label":"List findings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/findings/get-findings","routeSlug":"/rest-v1/findings/get-findings","metadata":{"seo":{"title":"List findings","description":"List findings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-findings","name":"List findings","isWebhook":false,"pointer":"/paths/~1v1~1findings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List findings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_439","description":"Filter by finding state."},{"name":"type","in":"query","schemaId":"schema_439","description":"Filter by the type of finding."},{"name":"employeeId","in":"query","schemaId":"schema_439","description":"Filter by the employee associated with the finding."},{"name":"appType","in":"query","schemaId":"schema_439","description":"Filter by the app that is associated with the finding."},{"name":"accountId","in":"query","schemaId":"schema_439","description":"Filter by the account that is associated with the finding."},{"name":"passwordId","in":"query","schemaId":"schema_439","description":"Filter by the password identifier that is associated with the finding."},{"name":"creationTimestampAfter","in":"query","schemaId":"schema_439","description":"Filter by when the finding was first observed - start time. This is a UNIX timestamp (in seconds)."},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440","description":"Filter by when the finding was first observed - end time. This is a UNIX timestamp (in seconds)."},{"name":"limit","in":"query","schemaId":"schema_441","description":"Used for pagination. Number of objects to return."},{"name":"offset","in":"query","schemaId":"schema_440","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Number of objects to skip. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}],"deprecated":true},{"name":"nextToken","in":"query","schemaId":"schema_439","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Used for pagination. Token to be used for the next request. Cannot be set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1findings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/findings","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[{"name":"state","in":"query","schemaId":"schema_439"},{"name":"type","in":"query","schemaId":"schema_439"},{"name":"employeeId","in":"query","schemaId":"schema_439"},{"name":"appType","in":"query","schemaId":"schema_439"},{"name":"accountId","in":"query","schemaId":"schema_439"},{"name":"passwordId","in":"query","schemaId":"schema_439"},{"name":"creationTimestampAfter","in":"query","schemaId":"schema_439"},{"name":"creationTimestampBefore","in":"query","schemaId":"schema_440"},{"name":"limit","in":"query","schemaId":"schema_441"},{"name":"offset","in":"query","schemaId":"schema_440"},{"name":"nextToken","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","422"],"pointer":"/v1/findings","href":"findings/get-findings","openApiOperationId":"get-findings","summary":"List findings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}},"schemaId":"schema_479"},{"code":"400","description":"Bad Request"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page of results is larger than the 1MB response size limit. Lower the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1findings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_479","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_479"}}},{"code":"400"},{"code":"422"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/findings/get-findings"}],"panels":[]}]},"httpPath":"/v1/findings"},{"label":"Retrieve a finding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/findings/get-findings-id","routeSlug":"/rest-v1/findings/get-findings-id","metadata":{"seo":{"title":"Retrieve a finding","description":"Retrieve a finding"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-findings-id","name":"Retrieve a finding","isWebhook":false,"pointer":"/paths/~1v1~1findings~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a finding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_439","description":"Unique identifier for the finding","required":true}],"pointer":"/paths/~1v1~1findings~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/findings/{id}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_439"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/findings/{id}","href":"findings/get-findings-id","openApiOperationId":"get-findings-id","summary":"Retrieve a finding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindingDetail"}},"schemaId":"components/schemas/FindingDetail","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1findings~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FindingDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindingDetail"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/findings/get-findings-id"}],"panels":[]}]},"httpPath":"/v1/findings/{id}"}],"content":{"contentType":"group","meta":{"name":"Findings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Findings","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the findings that have been found in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/findings","summary":"List findings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/findings/get-findings","deprecated":false},{"title":"/v1/findings/{id}","summary":"Retrieve a finding","prefix":{"name":"get","color":"get"},"badges":[],"link":"/findings/get-findings-id","deprecated":false}]}]}]}]}},{"type":"separator","label":"Controls","content":null},{"type":"group","label":"App banner","link":"/rest-v1/app-banner","routeSlug":"/rest-v1/app-banner","items":[{"label":"Retrieve the app banner configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/app-banner/get-controls-appbanner","routeSlug":"/rest-v1/app-banner/get-controls-appbanner","metadata":{"seo":{"title":"Retrieve the app banner configuration","description":"Returns your organization's current app banner configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-appBanner","name":"Retrieve the app banner configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1appBanner~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the app banner configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current app banner configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/appBanner/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/appBanner/configuration","href":"app-banner/get-controls-appbanner","openApiOperationId":"get-controls-appBanner","summary":"Retrieve the app banner configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerConfig"}},"schemaId":"components/schemas/AppBannerConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1appBanner~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppBannerConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-banner/get-controls-appbanner"}],"panels":[]}]},"httpPath":"/v1/controls/appBanner/configuration"},{"label":"Replace the app banner configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/app-banner/put-controls-appbanner","routeSlug":"/rest-v1/app-banner/put-controls-appbanner","metadata":{"seo":{"title":"Replace the app banner configuration","description":"Replaces your organization's app banner configuration with the configurationyou send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-appBanner","name":"Replace the app banner configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1appBanner~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the app banner configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's app banner configuration with the configuration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppBannerConfig","exampleIds":["paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"]}},"schemaId":"components/schemas/AppBannerConfig","exampleIds":["paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"],"pointer":"/paths/~1v1~1controls~1appBanner~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/appBanner/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppBannerConfig","exampleIds":["paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/appBanner/configuration","href":"app-banner/put-controls-appbanner","openApiOperationId":"put-controls-appBanner","summary":"Replace the app banner configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/AppBannerConfig","exampleIds":["paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppBannerConfig","exampleIds":["paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup","paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerConfig"}},"schemaId":"components/schemas/AppBannerConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1appBanner~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppBannerConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-banner/put-controls-appbanner"}],"panels":[]}]},"httpPath":"/v1/controls/appBanner/configuration"}],"content":{"contentType":"group","meta":{"name":"App banner"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App banner","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that show informational or blocking banners on apps across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/appBanner/configuration","summary":"Retrieve the app banner configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-banner/get-controls-appbanner","deprecated":false},{"title":"/v1/controls/appBanner/configuration","summary":"Replace the app banner configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/app-banner/put-controls-appbanner","deprecated":false}]}]}]}]}},{"type":"group","label":"App banner (URL pattern)","link":"/rest-v1/app-banner-(url-pattern)","routeSlug":"/rest-v1/app-banner-(url-pattern)","items":[{"label":"Retrieve the app banner (URL pattern) configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/app-banner-(url-pattern)/get-controls-appbannerurlpattern","routeSlug":"/rest-v1/app-banner-(url-pattern)/get-controls-appbannerurlpattern","metadata":{"seo":{"title":"Retrieve the app banner (URL pattern) configuration","description":"Returns your organization's current app banner (URL pattern) configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-appBannerUrlPattern","name":"Retrieve the app banner (URL pattern) configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1appBannerUrlPattern~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the app banner (URL pattern) configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current app banner (URL pattern) configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/appBannerUrlPattern/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/appBannerUrlPattern/configuration","href":"app-banner-(url-pattern)/get-controls-appbannerurlpattern","openApiOperationId":"get-controls-appBannerUrlPattern","summary":"Retrieve the app banner (URL pattern) configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig"}},"schemaId":"components/schemas/AppBannerUrlPatternConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1appBannerUrlPattern~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppBannerUrlPatternConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-banner-(url-pattern)/get-controls-appbannerurlpattern"}],"panels":[]}]},"httpPath":"/v1/controls/appBannerUrlPattern/configuration"},{"label":"Replace the app banner (URL pattern) configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/app-banner-(url-pattern)/put-controls-appbannerurlpattern","routeSlug":"/rest-v1/app-banner-(url-pattern)/put-controls-appbannerurlpattern","metadata":{"seo":{"title":"Replace the app banner (URL pattern) configuration","description":"Replaces your organization's app banner (URL pattern) configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-appBannerUrlPattern","name":"Replace the app banner (URL pattern) configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the app banner (URL pattern) configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's app banner (URL pattern) configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig","exampleIds":["paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"]}},"schemaId":"components/schemas/AppBannerUrlPatternConfig","exampleIds":["paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"],"pointer":"/paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/appBannerUrlPattern/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig","exampleIds":["paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/appBannerUrlPattern/configuration","href":"app-banner-(url-pattern)/put-controls-appbannerurlpattern","openApiOperationId":"put-controls-appBannerUrlPattern","summary":"Replace the app banner (URL pattern) configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/AppBannerUrlPatternConfig","exampleIds":["paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig","exampleIds":["paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig"}},"schemaId":"components/schemas/AppBannerUrlPatternConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppBannerUrlPatternConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppBannerUrlPatternConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/app-banner-(url-pattern)/put-controls-appbannerurlpattern"}],"panels":[]}]},"httpPath":"/v1/controls/appBannerUrlPattern/configuration"}],"content":{"contentType":"group","meta":{"name":"App banner (URL pattern)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App banner (URL pattern)","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that show informational or blocking banners on URL patterns across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/appBannerUrlPattern/configuration","summary":"Retrieve the app banner (URL pattern) configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/app-banner-(url-pattern)/get-controls-appbannerurlpattern","deprecated":false},{"title":"/v1/controls/appBannerUrlPattern/configuration","summary":"Replace the app banner (URL pattern) configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/app-banner-(url-pattern)/put-controls-appbannerurlpattern","deprecated":false}]}]}]}]}},{"type":"group","label":"Browser extension blocking","link":"/rest-v1/browser-extension-blocking","routeSlug":"/rest-v1/browser-extension-blocking","items":[{"label":"Retrieve the browser extension blocking configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/browser-extension-blocking/get-controls-browserextensionblocking","routeSlug":"/rest-v1/browser-extension-blocking/get-controls-browserextensionblocking","metadata":{"seo":{"title":"Retrieve the browser extension blocking configuration","description":"Returns your organization's current browser extension blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-browserExtensionBlocking","name":"Retrieve the browser extension blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1browserExtensionBlocking~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the browser extension blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current browser extension blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/browserExtensionBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/browserExtensionBlocking/configuration","href":"browser-extension-blocking/get-controls-browserextensionblocking","openApiOperationId":"get-controls-browserExtensionBlocking","summary":"Retrieve the browser extension blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig"}},"schemaId":"components/schemas/BrowserExtensionBlockingConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1browserExtensionBlocking~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrowserExtensionBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-extension-blocking/get-controls-browserextensionblocking"}],"panels":[]}]},"httpPath":"/v1/controls/browserExtensionBlocking/configuration"},{"label":"Replace the browser extension blocking configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/browser-extension-blocking/put-controls-browserextensionblocking","routeSlug":"/rest-v1/browser-extension-blocking/put-controls-browserextensionblocking","metadata":{"seo":{"title":"Replace the browser extension blocking configuration","description":"Replaces your organization's browser extension blocking configuration withthe configuration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-browserExtensionBlocking","name":"Replace the browser extension blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the browser extension blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's browser extension blocking configuration with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig","exampleIds":["paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/BrowserExtensionBlockingConfig","exampleIds":["paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/browserExtensionBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig","exampleIds":["paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/browserExtensionBlocking/configuration","href":"browser-extension-blocking/put-controls-browserextensionblocking","openApiOperationId":"put-controls-browserExtensionBlocking","summary":"Replace the browser extension blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/BrowserExtensionBlockingConfig","exampleIds":["paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig","exampleIds":["paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig"}},"schemaId":"components/schemas/BrowserExtensionBlockingConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BrowserExtensionBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BrowserExtensionBlockingConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/browser-extension-blocking/put-controls-browserextensionblocking"}],"panels":[]}]},"httpPath":"/v1/controls/browserExtensionBlocking/configuration"}],"content":{"contentType":"group","meta":{"name":"Browser extension blocking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Browser extension blocking","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that allow or block browser extensions across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/browserExtensionBlocking/configuration","summary":"Retrieve the browser extension blocking configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/browser-extension-blocking/get-controls-browserextensionblocking","deprecated":false},{"title":"/v1/controls/browserExtensionBlocking/configuration","summary":"Replace the browser extension blocking configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/browser-extension-blocking/put-controls-browserextensionblocking","deprecated":false}]}]}]}]}},{"type":"group","label":"Clipboard blocking","link":"/rest-v1/clipboard-blocking","routeSlug":"/rest-v1/clipboard-blocking","items":[{"label":"Retrieve the clipboard blocking configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/clipboard-blocking/get-controls-clipboardblocking","routeSlug":"/rest-v1/clipboard-blocking/get-controls-clipboardblocking","metadata":{"seo":{"title":"Retrieve the clipboard blocking configuration","description":"Returns your organization's current clipboard blocking configuration, including the control-wide globals and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-clipboardBlocking","name":"Retrieve the clipboard blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1clipboardBlocking~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the clipboard blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current clipboard blocking configuration, including the control-wide globals and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/clipboardBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/clipboardBlocking/configuration","href":"clipboard-blocking/get-controls-clipboardblocking","openApiOperationId":"get-controls-clipboardBlocking","summary":"Retrieve the clipboard blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig"}},"schemaId":"components/schemas/ClipboardBlockingConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1clipboardBlocking~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClipboardBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clipboard-blocking/get-controls-clipboardblocking"}],"panels":[]}]},"httpPath":"/v1/controls/clipboardBlocking/configuration"},{"label":"Replace the clipboard blocking configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/clipboard-blocking/put-controls-clipboardblocking","routeSlug":"/rest-v1/clipboard-blocking/put-controls-clipboardblocking","metadata":{"seo":{"title":"Replace the clipboard blocking configuration","description":"Replaces your organization's clipboard blocking configuration with theconfiguration you send. Any rule you don't include is deleted, andglobals.customContentPatterns replaces your entire custom-pattern list —send the complete set you want to keep, or an empty array to clear it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-clipboardBlocking","name":"Replace the clipboard blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1clipboardBlocking~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the clipboard blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's clipboard blocking configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"globals.customContentPatterns"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces your entire custom-pattern list —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send the complete set you want to keep, or an empty array to clear it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig","exampleIds":["paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"]}},"schemaId":"components/schemas/ClipboardBlockingConfig","exampleIds":["paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"],"pointer":"/paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody","description":"The complete configuration to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/clipboardBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig","exampleIds":["paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/clipboardBlocking/configuration","href":"clipboard-blocking/put-controls-clipboardblocking","openApiOperationId":"put-controls-clipboardBlocking","summary":"Replace the clipboard blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/ClipboardBlockingConfig","exampleIds":["paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig","exampleIds":["paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig"}},"schemaId":"components/schemas/ClipboardBlockingConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1clipboardBlocking~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClipboardBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClipboardBlockingConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/clipboard-blocking/put-controls-clipboardblocking"}],"panels":[]}]},"httpPath":"/v1/controls/clipboardBlocking/configuration"}],"content":{"contentType":"group","meta":{"name":"Clipboard blocking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clipboard blocking","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules and custom regex patterns that monitor or block clipboard activity across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/clipboardBlocking/configuration","summary":"Retrieve the clipboard blocking configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/clipboard-blocking/get-controls-clipboardblocking","deprecated":false},{"title":"/v1/controls/clipboardBlocking/configuration","summary":"Replace the clipboard blocking configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/clipboard-blocking/put-controls-clipboardblocking","deprecated":false}]}]}]}]}},{"type":"group","label":"Cloned login page detection","link":"/rest-v1/cloned-login-page-detection","routeSlug":"/rest-v1/cloned-login-page-detection","items":[{"label":"Retrieve the cloned login page detection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/cloned-login-page-detection/get-controls-clonedloginpagedetection","routeSlug":"/rest-v1/cloned-login-page-detection/get-controls-clonedloginpagedetection","metadata":{"seo":{"title":"Retrieve the cloned login page detection configuration","description":"Returns your organization's current cloned login page detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-clonedLoginPageDetection","name":"Retrieve the cloned login page detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the cloned login page detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current cloned login page detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/clonedLoginPageDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/clonedLoginPageDetection/configuration","href":"cloned-login-page-detection/get-controls-clonedloginpagedetection","openApiOperationId":"get-controls-clonedLoginPageDetection","summary":"Retrieve the cloned login page detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"}},"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClonedLoginPageDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloned-login-page-detection/get-controls-clonedloginpagedetection"}],"panels":[]}]},"httpPath":"/v1/controls/clonedLoginPageDetection/configuration"},{"label":"Replace the cloned login page detection configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/cloned-login-page-detection/put-controls-clonedloginpagedetection","routeSlug":"/rest-v1/cloned-login-page-detection/put-controls-clonedloginpagedetection","metadata":{"seo":{"title":"Replace the cloned login page detection configuration","description":"Replaces your organization's cloned login page detection configuration withthe configuration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-clonedLoginPageDetection","name":"Replace the cloned login page detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the cloned login page detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's cloned login page detection configuration with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig","exampleIds":["paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"]}},"schemaId":"components/schemas/ClonedLoginPageDetectionConfig","exampleIds":["paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"],"pointer":"/paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/clonedLoginPageDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig","exampleIds":["paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/clonedLoginPageDetection/configuration","href":"cloned-login-page-detection/put-controls-clonedloginpagedetection","openApiOperationId":"put-controls-clonedLoginPageDetection","summary":"Replace the cloned login page detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/ClonedLoginPageDetectionConfig","exampleIds":["paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig","exampleIds":["paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup","paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"}},"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClonedLoginPageDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClonedLoginPageDetectionConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cloned-login-page-detection/put-controls-clonedloginpagedetection"}],"panels":[]}]},"httpPath":"/v1/controls/clonedLoginPageDetection/configuration"}],"content":{"contentType":"group","meta":{"name":"Cloned login page detection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloned login page detection","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that detect cloned login pages across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/clonedLoginPageDetection/configuration","summary":"Retrieve the cloned login page detection configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cloned-login-page-detection/get-controls-clonedloginpagedetection","deprecated":false},{"title":"/v1/controls/clonedLoginPageDetection/configuration","summary":"Replace the cloned login page detection configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cloned-login-page-detection/put-controls-clonedloginpagedetection","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom detections","link":"/rest-v1/custom-detections","routeSlug":"/rest-v1/custom-detections","items":[{"label":"List custom detections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/custom-detections/get-controls-customdetections","routeSlug":"/rest-v1/custom-detections/get-controls-customdetections","metadata":{"seo":{"title":"List custom detections","description":"Returns your organization's custom detections. Each entry includes the detection event type and name only; retrieve a detection individually for its logic and rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-customDetections","name":"List custom detections","isWebhook":false,"pointer":"/paths/~1v1~1controls~1customDetections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom detections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's custom detections. Each entry includes the detection event type and name only; retrieve a detection individually for its logic and rules."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/customDetections","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/customDetections","href":"custom-detections/get-controls-customdetections","openApiOperationId":"get-controls-customDetections","summary":"List custom detections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_480"}},"schemaId":"schema_480"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1customDetections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_480","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_480"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-detections/get-controls-customdetections"}],"panels":[]}]},"httpPath":"/v1/controls/customDetections"},{"label":"Add a custom detection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/custom-detections/post-controls-customdetections","routeSlug":"/rest-v1/custom-detections/post-controls-customdetections","metadata":{"seo":{"title":"Add a custom detection","description":"Creates a custom detection from the name, detection logic and rules you send. The detection event type is derived from the name, returned in the response, and cannot be changed afterwards. Rules are evaluated in the order you send them, and the first rule that matches wins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-controls-customDetections","name":"Add a custom detection","isWebhook":false,"pointer":"/paths/~1v1~1controls~1customDetections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a custom detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a custom detection from the name, detection logic and rules you send. The detection event type is derived from the name, returned in the response, and cannot be changed afterwards. Rules are evaluated in the order you send them, and the first rule that matches wins."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomDetectionPost"}},"schemaId":"components/schemas/CustomDetectionPost","pointer":"/paths/~1v1~1controls~1customDetections/post/requestBody","description":"The new custom detection's complete state."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/controls/customDetections","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomDetectionPost"}},"responseCodes":["200","400","403","409"],"pointer":"/v1/controls/customDetections","href":"custom-detections/post-controls-customdetections","openApiOperationId":"post-controls-customDetections","summary":"Add a custom detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/CustomDetectionPost","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomDetectionPost"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}},"schemaId":"components/schemas/CustomDetection"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"409","description":"Conflict (a custom detection with the derived detection event type already exists)"}],"pointer":"/paths/~1v1~1controls~1customDetections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomDetection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}}},{"code":"400"},{"code":"403"},{"code":"409"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-detections/post-controls-customdetections"}],"panels":[]}]},"httpPath":"/v1/controls/customDetections"},{"label":"Retrieve a custom detection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/custom-detections/get-controls-customdetections-detectioneventtype","routeSlug":"/rest-v1/custom-detections/get-controls-customdetections-detectioneventtype","metadata":{"seo":{"title":"Retrieve a custom detection","description":"Returns one custom detection in full: its detection logic exactly as stored, and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-customDetections-detectionEventType","name":"Retrieve a custom detection","isWebhook":false,"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a custom detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns one custom detection in full: its detection logic exactly as stored, and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"detectionEventType","in":"path","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's unique identifier. Always an uppercase identifier beginning with CUSTOM_."},"children":[]}]}]}],"required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/customDetections/{detectionEventType}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"detectionEventType","in":"path","required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT","schemaId":"schema_481"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/customDetections/{detectionEventType}","href":"custom-detections/get-controls-customdetections-detectioneventtype","openApiOperationId":"get-controls-customDetections-detectionEventType","summary":"Retrieve a custom detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}},"schemaId":"components/schemas/CustomDetection"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomDetection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-detections/get-controls-customdetections-detectioneventtype"}],"panels":[]}]},"httpPath":"/v1/controls/customDetections/{detectionEventType}"},{"label":"Replace a custom detection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/custom-detections/put-controls-customdetections-detectioneventtype","routeSlug":"/rest-v1/custom-detections/put-controls-customdetections-detectioneventtype","metadata":{"seo":{"title":"Replace a custom detection","description":"Replaces the custom detection's logic and rules with what you send. Any ruleyou don't include is deleted. The detection event name cannot be changed,and is ignored if you send one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-customDetections-detectionEventType","name":"Replace a custom detection","isWebhook":false,"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a custom detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the custom detection's logic and rules with what you send. Any rule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you don't include is deleted. The detection event name cannot be changed,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and is ignored if you send one."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of a detection, retrieve it first, apply your changes, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"send the complete detection back. Sending a detection that matches what's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored, rule "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"s included, changes nothing, so a job that re-syncs your"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detections is safe to run repeatedly."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"detectionEventType","in":"path","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's unique identifier. Always an uppercase identifier beginning with CUSTOM_."},"children":[]}]}]}],"required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomDetectionPut","exampleIds":["paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone","paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"]}},"schemaId":"components/schemas/CustomDetectionPut","exampleIds":["paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone","paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody","description":"The custom detection's complete desired state."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/customDetections/{detectionEventType}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"detectionEventType","in":"path","required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT","schemaId":"schema_481"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomDetectionPut","exampleIds":["paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone","paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/customDetections/{detectionEventType}","href":"custom-detections/put-controls-customdetections-detectioneventtype","openApiOperationId":"put-controls-customDetections-detectionEventType","summary":"Replace a custom detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/CustomDetectionPut","exampleIds":["paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone","paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomDetectionPut","exampleIds":["paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone","paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}},"schemaId":"components/schemas/CustomDetection"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomDetection","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomDetection"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-detections/put-controls-customdetections-detectioneventtype"}],"panels":[]}]},"httpPath":"/v1/controls/customDetections/{detectionEventType}"},{"label":"Delete a custom detection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/custom-detections/delete-controls-customdetections-detectioneventtype","routeSlug":"/rest-v1/custom-detections/delete-controls-customdetections-detectioneventtype","metadata":{"seo":{"title":"Delete a custom detection","description":"Permanently deletes a custom detection and all of its rules. It cannot be undone. Deleting a detection that does not exist succeeds without making any changes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-controls-customDetections-detectionEventType","name":"Delete a custom detection","isWebhook":false,"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom detection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes a custom detection and all of its rules. It cannot be undone. Deleting a detection that does not exist succeeds without making any changes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"detectionEventType","in":"path","schemaId":"schema_481","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's unique identifier. Always an uppercase identifier beginning with CUSTOM_."},"children":[]}]}]}],"required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/controls/customDetections/{detectionEventType}","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[{"name":"detectionEventType","in":"path","required":true,"example":"CUSTOM_TORRENT_WEBSITE_VISIT","schemaId":"schema_481"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","403"],"pointer":"/v1/controls/customDetections/{detectionEventType}","href":"custom-detections/delete-controls-customdetections-detectioneventtype","openApiOperationId":"delete-controls-customDetections-detectionEventType","summary":"Delete a custom detection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"403","description":"Forbidden (read-only API key)"}],"pointer":"/paths/~1v1~1controls~1customDetections~1{detectionEventType}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-detections/delete-controls-customdetections-detectioneventtype"}],"panels":[]}]},"httpPath":"/v1/controls/customDetections/{detectionEventType}"}],"content":{"contentType":"group","meta":{"name":"Custom detections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom detections","showPageActions":true},{"nodeType":"markdoc","content":"Manage the custom detections configured across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/customDetections","summary":"List custom detections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-detections/get-controls-customdetections","deprecated":false},{"title":"/v1/controls/customDetections","summary":"Add a custom detection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-detections/post-controls-customdetections","deprecated":false},{"title":"/v1/controls/customDetections/{detectionEventType}","summary":"Retrieve a custom detection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-detections/get-controls-customdetections-detectioneventtype","deprecated":false},{"title":"/v1/controls/customDetections/{detectionEventType}","summary":"Replace a custom detection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-detections/put-controls-customdetections-detectioneventtype","deprecated":false},{"title":"/v1/controls/customDetections/{detectionEventType}","summary":"Delete a custom detection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-detections/delete-controls-customdetections-detectioneventtype","deprecated":false}]}]}]}]}},{"type":"group","label":"File download blocking","link":"/rest-v1/file-download-blocking","routeSlug":"/rest-v1/file-download-blocking","items":[{"label":"Retrieve the file download blocking configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-download-blocking/get-controls-filedownloadblocking","routeSlug":"/rest-v1/file-download-blocking/get-controls-filedownloadblocking","metadata":{"seo":{"title":"Retrieve the file download blocking configuration","description":"Returns your organization's current file download blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-fileDownloadBlocking","name":"Retrieve the file download blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1fileDownloadBlocking~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the file download blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current file download blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/fileDownloadBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/fileDownloadBlocking/configuration","href":"file-download-blocking/get-controls-filedownloadblocking","openApiOperationId":"get-controls-fileDownloadBlocking","summary":"Retrieve the file download blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig"}},"schemaId":"components/schemas/FileDownloadBlockingConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1fileDownloadBlocking~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDownloadBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-download-blocking/get-controls-filedownloadblocking"}],"panels":[]}]},"httpPath":"/v1/controls/fileDownloadBlocking/configuration"},{"label":"Replace the file download blocking configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-download-blocking/put-controls-filedownloadblocking","routeSlug":"/rest-v1/file-download-blocking/put-controls-filedownloadblocking","metadata":{"seo":{"title":"Replace the file download blocking configuration","description":"Replaces your organization's file download blocking configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-fileDownloadBlocking","name":"Replace the file download blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the file download blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's file download blocking configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/FileDownloadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/fileDownloadBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/fileDownloadBlocking/configuration","href":"file-download-blocking/put-controls-filedownloadblocking","openApiOperationId":"put-controls-fileDownloadBlocking","summary":"Replace the file download blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/FileDownloadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig"}},"schemaId":"components/schemas/FileDownloadBlockingConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDownloadBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadBlockingConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-download-blocking/put-controls-filedownloadblocking"}],"panels":[]}]},"httpPath":"/v1/controls/fileDownloadBlocking/configuration"}],"content":{"contentType":"group","meta":{"name":"File download blocking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File download blocking","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that block file downloads across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/fileDownloadBlocking/configuration","summary":"Retrieve the file download blocking configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-download-blocking/get-controls-filedownloadblocking","deprecated":false},{"title":"/v1/controls/fileDownloadBlocking/configuration","summary":"Replace the file download blocking configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/file-download-blocking/put-controls-filedownloadblocking","deprecated":false}]}]}]}]}},{"type":"group","label":"File upload blocking","link":"/rest-v1/file-upload-blocking","routeSlug":"/rest-v1/file-upload-blocking","items":[{"label":"Retrieve the file upload blocking configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-upload-blocking/get-controls-fileuploadblocking","routeSlug":"/rest-v1/file-upload-blocking/get-controls-fileuploadblocking","metadata":{"seo":{"title":"Retrieve the file upload blocking configuration","description":"Returns your organization's current file upload blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-fileUploadBlocking","name":"Retrieve the file upload blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1fileUploadBlocking~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the file upload blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current file upload blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/fileUploadBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/fileUploadBlocking/configuration","href":"file-upload-blocking/get-controls-fileuploadblocking","openApiOperationId":"get-controls-fileUploadBlocking","summary":"Retrieve the file upload blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig"}},"schemaId":"components/schemas/FileUploadBlockingConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1fileUploadBlocking~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload-blocking/get-controls-fileuploadblocking"}],"panels":[]}]},"httpPath":"/v1/controls/fileUploadBlocking/configuration"},{"label":"Replace the file upload blocking configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-upload-blocking/put-controls-fileuploadblocking","routeSlug":"/rest-v1/file-upload-blocking/put-controls-fileuploadblocking","metadata":{"seo":{"title":"Replace the file upload blocking configuration","description":"Replaces your organization's file upload blocking configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-fileUploadBlocking","name":"Replace the file upload blocking configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1fileUploadBlocking~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the file upload blocking configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's file upload blocking configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/FileUploadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/fileUploadBlocking/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/fileUploadBlocking/configuration","href":"file-upload-blocking/put-controls-fileuploadblocking","openApiOperationId":"put-controls-fileUploadBlocking","summary":"Replace the file upload blocking configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/FileUploadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig","exampleIds":["paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig"}},"schemaId":"components/schemas/FileUploadBlockingConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadBlockingConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadBlockingConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload-blocking/put-controls-fileuploadblocking"}],"panels":[]}]},"httpPath":"/v1/controls/fileUploadBlocking/configuration"}],"content":{"contentType":"group","meta":{"name":"File upload blocking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File upload blocking","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that block file uploads across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/fileUploadBlocking/configuration","summary":"Retrieve the file upload blocking configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-upload-blocking/get-controls-fileuploadblocking","deprecated":false},{"title":"/v1/controls/fileUploadBlocking/configuration","summary":"Replace the file upload blocking configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/file-upload-blocking/put-controls-fileuploadblocking","deprecated":false}]}]}]}]}},{"type":"group","label":"MFA enforcement","link":"/rest-v1/mfa-enforcement","routeSlug":"/rest-v1/mfa-enforcement","items":[{"label":"Retrieve the MFA enforcement configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/mfa-enforcement/get-controls-mfaenforcement","routeSlug":"/rest-v1/mfa-enforcement/get-controls-mfaenforcement","metadata":{"seo":{"title":"Retrieve the MFA enforcement configuration","description":"Returns your organization's current MFA enforcement configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-mfaEnforcement","name":"Retrieve the MFA enforcement configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1mfaEnforcement~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the MFA enforcement configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current MFA enforcement configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/mfaEnforcement/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/mfaEnforcement/configuration","href":"mfa-enforcement/get-controls-mfaenforcement","openApiOperationId":"get-controls-mfaEnforcement","summary":"Retrieve the MFA enforcement configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig"}},"schemaId":"components/schemas/MfaEnforcementConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1mfaEnforcement~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MfaEnforcementConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mfa-enforcement/get-controls-mfaenforcement"}],"panels":[]}]},"httpPath":"/v1/controls/mfaEnforcement/configuration"},{"label":"Replace the MFA enforcement configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/mfa-enforcement/put-controls-mfaenforcement","routeSlug":"/rest-v1/mfa-enforcement/put-controls-mfaenforcement","metadata":{"seo":{"title":"Replace the MFA enforcement configuration","description":"Replaces your organization's MFA enforcement configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-mfaEnforcement","name":"Replace the MFA enforcement configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1mfaEnforcement~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the MFA enforcement configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's MFA enforcement configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig","exampleIds":["paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"schemaId":"components/schemas/MfaEnforcementConfig","exampleIds":["paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"],"pointer":"/paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/mfaEnforcement/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig","exampleIds":["paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/mfaEnforcement/configuration","href":"mfa-enforcement/put-controls-mfaenforcement","openApiOperationId":"put-controls-mfaEnforcement","summary":"Replace the MFA enforcement configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/MfaEnforcementConfig","exampleIds":["paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig","exampleIds":["paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig"}},"schemaId":"components/schemas/MfaEnforcementConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1mfaEnforcement~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MfaEnforcementConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MfaEnforcementConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/mfa-enforcement/put-controls-mfaenforcement"}],"panels":[]}]},"httpPath":"/v1/controls/mfaEnforcement/configuration"}],"content":{"contentType":"group","meta":{"name":"MFA enforcement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"MFA enforcement","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that enforce multi-factor authentication across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/mfaEnforcement/configuration","summary":"Retrieve the MFA enforcement configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mfa-enforcement/get-controls-mfaenforcement","deprecated":false},{"title":"/v1/controls/mfaEnforcement/configuration","summary":"Replace the MFA enforcement configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mfa-enforcement/put-controls-mfaenforcement","deprecated":false}]}]}]}]}},{"type":"group","label":"Malicious browser extension detection","link":"/rest-v1/malicious-browser-extension-detection","routeSlug":"/rest-v1/malicious-browser-extension-detection","items":[{"label":"Retrieve the malicious browser extension detection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/malicious-browser-extension-detection/get-controls-maliciousbrowserextensiondetection","routeSlug":"/rest-v1/malicious-browser-extension-detection/get-controls-maliciousbrowserextensiondetection","metadata":{"seo":{"title":"Retrieve the malicious browser extension detection configuration","description":"Returns your organization's current malicious browser extension detection configuration, including the control-wide globals and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-maliciousBrowserExtensionDetection","name":"Retrieve the malicious browser extension detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the malicious browser extension detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current malicious browser extension detection configuration, including the control-wide globals and every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/maliciousBrowserExtensionDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/maliciousBrowserExtensionDetection/configuration","href":"malicious-browser-extension-detection/get-controls-maliciousbrowserextensiondetection","openApiOperationId":"get-controls-maliciousBrowserExtensionDetection","summary":"Retrieve the malicious browser extension detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"}},"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/malicious-browser-extension-detection/get-controls-maliciousbrowserextensiondetection"}],"panels":[]}]},"httpPath":"/v1/controls/maliciousBrowserExtensionDetection/configuration"},{"label":"Replace the malicious browser extension detection configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/malicious-browser-extension-detection/put-controls-maliciousbrowserextensiondetection","routeSlug":"/rest-v1/malicious-browser-extension-detection/put-controls-maliciousbrowserextensiondetection","metadata":{"seo":{"title":"Replace the malicious browser extension detection configuration","description":"Replaces your organization's malicious browser extension detectionconfiguration with the configuration you send. Any rule you don't include isdeleted, and globals.excludedExtensions replaces your entireexcluded-extension list — send the complete set you want to keep, or anempty array to clear it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-maliciousBrowserExtensionDetection","name":"Replace the malicious browser extension detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the malicious browser extension detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's malicious browser extension detection"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration with the configuration you send. Any rule you don't include is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"globals.excludedExtensions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" replaces your entire"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excluded-extension list — send the complete set you want to keep, or an"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"empty array to clear it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody","description":"The complete configuration to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/maliciousBrowserExtensionDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/maliciousBrowserExtensionDetection/configuration","href":"malicious-browser-extension-detection/put-controls-maliciousbrowserextensiondetection","openApiOperationId":"put-controls-maliciousBrowserExtensionDetection","summary":"Replace the malicious browser extension detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"}},"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousBrowserExtensionDetectionConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/malicious-browser-extension-detection/put-controls-maliciousbrowserextensiondetection"}],"panels":[]}]},"httpPath":"/v1/controls/maliciousBrowserExtensionDetection/configuration"}],"content":{"contentType":"group","meta":{"name":"Malicious browser extension detection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Malicious browser extension detection","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules and excluded extensions that detect malicious browser extensions across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/maliciousBrowserExtensionDetection/configuration","summary":"Retrieve the malicious browser extension detection configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/malicious-browser-extension-detection/get-controls-maliciousbrowserextensiondetection","deprecated":false},{"title":"/v1/controls/maliciousBrowserExtensionDetection/configuration","summary":"Replace the malicious browser extension detection configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/malicious-browser-extension-detection/put-controls-maliciousbrowserextensiondetection","deprecated":false}]}]}]}]}},{"type":"group","label":"Malicious copy paste detection","link":"/rest-v1/malicious-copy-paste-detection","routeSlug":"/rest-v1/malicious-copy-paste-detection","items":[{"label":"Retrieve the malicious copy paste detection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/malicious-copy-paste-detection/get-controls-maliciouscopypastedetection","routeSlug":"/rest-v1/malicious-copy-paste-detection/get-controls-maliciouscopypastedetection","metadata":{"seo":{"title":"Retrieve the malicious copy paste detection configuration","description":"Returns your organization's current malicious copy paste detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-maliciousCopyPasteDetection","name":"Retrieve the malicious copy paste detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the malicious copy paste detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current malicious copy paste detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/maliciousCopyPasteDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/maliciousCopyPasteDetection/configuration","href":"malicious-copy-paste-detection/get-controls-maliciouscopypastedetection","openApiOperationId":"get-controls-maliciousCopyPasteDetection","summary":"Retrieve the malicious copy paste detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"}},"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/malicious-copy-paste-detection/get-controls-maliciouscopypastedetection"}],"panels":[]}]},"httpPath":"/v1/controls/maliciousCopyPasteDetection/configuration"},{"label":"Replace the malicious copy paste detection configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/malicious-copy-paste-detection/put-controls-maliciouscopypastedetection","routeSlug":"/rest-v1/malicious-copy-paste-detection/put-controls-maliciouscopypastedetection","metadata":{"seo":{"title":"Replace the malicious copy paste detection configuration","description":"Replaces your organization's malicious copy paste detection configurationwith the configuration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-maliciousCopyPasteDetection","name":"Replace the malicious copy paste detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the malicious copy paste detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's malicious copy paste detection configuration"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/maliciousCopyPasteDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/maliciousCopyPasteDetection/configuration","href":"malicious-copy-paste-detection/put-controls-maliciouscopypastedetection","openApiOperationId":"put-controls-maliciousCopyPasteDetection","summary":"Replace the malicious copy paste detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","exampleIds":["paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"}},"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MaliciousCopyPasteDetectionConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/malicious-copy-paste-detection/put-controls-maliciouscopypastedetection"}],"panels":[]}]},"httpPath":"/v1/controls/maliciousCopyPasteDetection/configuration"}],"content":{"contentType":"group","meta":{"name":"Malicious copy paste detection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Malicious copy paste detection","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that detect malicious copy-paste activity across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/maliciousCopyPasteDetection/configuration","summary":"Retrieve the malicious copy paste detection configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/malicious-copy-paste-detection/get-controls-maliciouscopypastedetection","deprecated":false},{"title":"/v1/controls/maliciousCopyPasteDetection/configuration","summary":"Replace the malicious copy paste detection configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/malicious-copy-paste-detection/put-controls-maliciouscopypastedetection","deprecated":false}]}]}]}]}},{"type":"group","label":"Password logging prevention","link":"/rest-v1/password-logging-prevention","routeSlug":"/rest-v1/password-logging-prevention","items":[{"label":"Retrieve the password logging prevention configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/password-logging-prevention/get-controls-passwordloggingprevention","routeSlug":"/rest-v1/password-logging-prevention/get-controls-passwordloggingprevention","metadata":{"seo":{"title":"Retrieve the password logging prevention configuration","description":"Returns your organization's current password logging prevention configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-passwordLoggingPrevention","name":"Retrieve the password logging prevention configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the password logging prevention configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current password logging prevention configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/passwordLoggingPrevention/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/passwordLoggingPrevention/configuration","href":"password-logging-prevention/get-controls-passwordloggingprevention","openApiOperationId":"get-controls-passwordLoggingPrevention","summary":"Retrieve the password logging prevention configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig"}},"schemaId":"components/schemas/PasswordLoggingPreventionConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PasswordLoggingPreventionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/password-logging-prevention/get-controls-passwordloggingprevention"}],"panels":[]}]},"httpPath":"/v1/controls/passwordLoggingPrevention/configuration"},{"label":"Replace the password logging prevention configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/password-logging-prevention/put-controls-passwordloggingprevention","routeSlug":"/rest-v1/password-logging-prevention/put-controls-passwordloggingprevention","metadata":{"seo":{"title":"Replace the password logging prevention configuration","description":"Replaces your organization's password logging prevention configuration withthe configuration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-passwordLoggingPrevention","name":"Replace the password logging prevention configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the password logging prevention configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's password logging prevention configuration with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig","exampleIds":["paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"schemaId":"components/schemas/PasswordLoggingPreventionConfig","exampleIds":["paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"pointer":"/paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/passwordLoggingPrevention/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig","exampleIds":["paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/passwordLoggingPrevention/configuration","href":"password-logging-prevention/put-controls-passwordloggingprevention","openApiOperationId":"put-controls-passwordLoggingPrevention","summary":"Replace the password logging prevention configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/PasswordLoggingPreventionConfig","exampleIds":["paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig","exampleIds":["paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig"}},"schemaId":"components/schemas/PasswordLoggingPreventionConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PasswordLoggingPreventionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PasswordLoggingPreventionConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/password-logging-prevention/put-controls-passwordloggingprevention"}],"panels":[]}]},"httpPath":"/v1/controls/passwordLoggingPrevention/configuration"}],"content":{"contentType":"group","meta":{"name":"Password logging prevention"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Password logging prevention","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that prevent password logging across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/passwordLoggingPrevention/configuration","summary":"Retrieve the password logging prevention configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/password-logging-prevention/get-controls-passwordloggingprevention","deprecated":false},{"title":"/v1/controls/passwordLoggingPrevention/configuration","summary":"Replace the password logging prevention configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/password-logging-prevention/put-controls-passwordloggingprevention","deprecated":false}]}]}]}]}},{"type":"group","label":"Phishing tool detection","link":"/rest-v1/phishing-tool-detection","routeSlug":"/rest-v1/phishing-tool-detection","items":[{"label":"Retrieve the phishing tool detection configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/phishing-tool-detection/get-controls-phishingtooldetection","routeSlug":"/rest-v1/phishing-tool-detection/get-controls-phishingtooldetection","metadata":{"seo":{"title":"Retrieve the phishing tool detection configuration","description":"Returns your organization's current phishing tool detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-phishingToolDetection","name":"Retrieve the phishing tool detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1phishingToolDetection~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the phishing tool detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current phishing tool detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/phishingToolDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/phishingToolDetection/configuration","href":"phishing-tool-detection/get-controls-phishingtooldetection","openApiOperationId":"get-controls-phishingToolDetection","summary":"Retrieve the phishing tool detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig"}},"schemaId":"components/schemas/PhishingToolDetectionConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1phishingToolDetection~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhishingToolDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phishing-tool-detection/get-controls-phishingtooldetection"}],"panels":[]}]},"httpPath":"/v1/controls/phishingToolDetection/configuration"},{"label":"Replace the phishing tool detection configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/phishing-tool-detection/put-controls-phishingtooldetection","routeSlug":"/rest-v1/phishing-tool-detection/put-controls-phishingtooldetection","metadata":{"seo":{"title":"Replace the phishing tool detection configuration","description":"Replaces your organization's phishing tool detection configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-phishingToolDetection","name":"Replace the phishing tool detection configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1phishingToolDetection~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the phishing tool detection configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's phishing tool detection configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig","exampleIds":["paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"]}},"schemaId":"components/schemas/PhishingToolDetectionConfig","exampleIds":["paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"],"pointer":"/paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/phishingToolDetection/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig","exampleIds":["paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/phishingToolDetection/configuration","href":"phishing-tool-detection/put-controls-phishingtooldetection","openApiOperationId":"put-controls-phishingToolDetection","summary":"Replace the phishing tool detection configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/PhishingToolDetectionConfig","exampleIds":["paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig","exampleIds":["paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig"}},"schemaId":"components/schemas/PhishingToolDetectionConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1phishingToolDetection~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PhishingToolDetectionConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhishingToolDetectionConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phishing-tool-detection/put-controls-phishingtooldetection"}],"panels":[]}]},"httpPath":"/v1/controls/phishingToolDetection/configuration"}],"content":{"contentType":"group","meta":{"name":"Phishing tool detection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phishing tool detection","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that detect phishing tools across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/phishingToolDetection/configuration","summary":"Retrieve the phishing tool detection configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/phishing-tool-detection/get-controls-phishingtooldetection","deprecated":false},{"title":"/v1/controls/phishingToolDetection/configuration","summary":"Replace the phishing tool detection configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/phishing-tool-detection/put-controls-phishingtooldetection","deprecated":false}]}]}]}]}},{"type":"group","label":"Stolen credential detection","link":"/rest-v1/stolen-credential-detection","routeSlug":"/rest-v1/stolen-credential-detection","items":[{"label":"Add new stolen credentials","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/stolen-credential-detection/post-controls-stolencredentials","routeSlug":"/rest-v1/stolen-credential-detection/post-controls-stolencredentials","metadata":{"seo":{"title":"Add new stolen credentials","description":"Add stolen credentials sourced from other threat intelligence feeds within your organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-controls-stolenCredentials","name":"Add new stolen credentials","isWebhook":false,"pointer":"/paths/~1v1~1controls~1stolenCredentials/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add new stolen credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add stolen credentials sourced from other threat intelligence feeds within your organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482","pointer":"/paths/~1v1~1controls~1stolenCredentials/post/requestBody","description":"A list of stolen credentials"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/controls/stolenCredentials","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_482"}},"responseCodes":["200","400"],"pointer":"/v1/controls/stolenCredentials","href":"stolen-credential-detection/post-controls-stolencredentials","openApiOperationId":"post-controls-stolenCredentials","summary":"Add new stolen credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_482"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}},"schemaId":"schema_483","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1controls~1stolenCredentials/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_483","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stolen-credential-detection/post-controls-stolencredentials"}],"panels":[]}]},"httpPath":"/v1/controls/stolenCredentials"},{"label":"Delete all stolen credentials","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/stolen-credential-detection/delete-controls-stolencredentials","routeSlug":"/rest-v1/stolen-credential-detection/delete-controls-stolencredentials","metadata":{"seo":{"title":"Delete all stolen credentials","description":"Delete all the custom stolen credentials that you have added to your organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-controls-stolenCredentials","name":"Delete all stolen credentials","isWebhook":false,"pointer":"/paths/~1v1~1controls~1stolenCredentials/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all stolen credentials","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete all the custom stolen credentials that you have added to your organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/controls/stolenCredentials","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/controls/stolenCredentials","href":"stolen-credential-detection/delete-controls-stolencredentials","openApiOperationId":"delete-controls-stolenCredentials","summary":"Delete all stolen credentials"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1controls~1stolenCredentials/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stolen-credential-detection/delete-controls-stolencredentials"}],"panels":[]}]},"httpPath":"/v1/controls/stolenCredentials"}],"content":{"contentType":"group","meta":{"name":"Stolen credential detection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stolen credential detection","showPageActions":true},{"nodeType":"markdoc","content":"Manage custom stolen credentials that you have added to your organization for monitoring and enforcement."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/stolenCredentials","summary":"Add new stolen credentials","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stolen-credential-detection/post-controls-stolencredentials","deprecated":false},{"title":"/v1/controls/stolenCredentials","summary":"Delete all stolen credentials","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stolen-credential-detection/delete-controls-stolencredentials","deprecated":false}]}]}]}]}},{"type":"group","label":"Strong password enforcement","link":"/rest-v1/strong-password-enforcement","routeSlug":"/rest-v1/strong-password-enforcement","items":[{"label":"Retrieve the strong password enforcement configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/strong-password-enforcement/get-controls-strongpasswordenforcement","routeSlug":"/rest-v1/strong-password-enforcement/get-controls-strongpasswordenforcement","metadata":{"seo":{"title":"Retrieve the strong password enforcement configuration","description":"Returns your organization's current strong password enforcement configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-strongPasswordEnforcement","name":"Retrieve the strong password enforcement configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the strong password enforcement configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current strong password enforcement configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/strongPasswordEnforcement/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/controls/strongPasswordEnforcement/configuration","href":"strong-password-enforcement/get-controls-strongpasswordenforcement","openApiOperationId":"get-controls-strongPasswordEnforcement","summary":"Retrieve the strong password enforcement configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig"}},"schemaId":"components/schemas/StrongPasswordEnforcementConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StrongPasswordEnforcementConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/strong-password-enforcement/get-controls-strongpasswordenforcement"}],"panels":[]}]},"httpPath":"/v1/controls/strongPasswordEnforcement/configuration"},{"label":"Replace the strong password enforcement configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/strong-password-enforcement/put-controls-strongpasswordenforcement","routeSlug":"/rest-v1/strong-password-enforcement/put-controls-strongpasswordenforcement","metadata":{"seo":{"title":"Replace the strong password enforcement configuration","description":"Replaces your organization's strong password enforcement configuration withthe configuration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-controls-strongPasswordEnforcement","name":"Replace the strong password enforcement configuration","isWebhook":false,"pointer":"/paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the strong password enforcement configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's strong password enforcement configuration with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig","exampleIds":["paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"schemaId":"components/schemas/StrongPasswordEnforcementConfig","exampleIds":["paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"],"pointer":"/paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/controls/strongPasswordEnforcement/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig","exampleIds":["paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/controls/strongPasswordEnforcement/configuration","href":"strong-password-enforcement/put-controls-strongpasswordenforcement","openApiOperationId":"put-controls-strongPasswordEnforcement","summary":"Replace the strong password enforcement configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/StrongPasswordEnforcementConfig","exampleIds":["paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig","exampleIds":["paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig"}},"schemaId":"components/schemas/StrongPasswordEnforcementConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StrongPasswordEnforcementConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StrongPasswordEnforcementConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/strong-password-enforcement/put-controls-strongpasswordenforcement"}],"panels":[]}]},"httpPath":"/v1/controls/strongPasswordEnforcement/configuration"}],"content":{"contentType":"group","meta":{"name":"Strong password enforcement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Strong password enforcement","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that enforce strong passwords across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/strongPasswordEnforcement/configuration","summary":"Retrieve the strong password enforcement configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/strong-password-enforcement/get-controls-strongpasswordenforcement","deprecated":false},{"title":"/v1/controls/strongPasswordEnforcement/configuration","summary":"Replace the strong password enforcement configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/strong-password-enforcement/put-controls-strongpasswordenforcement","deprecated":false}]}]}]}]}},{"type":"group","label":"URL blocking","link":"/rest-v1/url-blocking","routeSlug":"/rest-v1/url-blocking","items":[{"label":"List all blocked URLs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/url-blocking/get-controls-blockedurls","routeSlug":"/rest-v1/url-blocking/get-controls-blockedurls","metadata":{"seo":{"title":"List all blocked URLs","description":"List all blocked URLs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-controls-blockedUrls","name":"List all blocked URLs","isWebhook":false,"pointer":"/paths/~1v1~1controls~1blockedUrls/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all blocked URLs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/controls/blockedUrls","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/controls/blockedUrls","href":"url-blocking/get-controls-blockedurls","openApiOperationId":"get-controls-blockedUrls","summary":"List all blocked URLs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}},"schemaId":"schema_484","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1controls~1blockedUrls/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_484","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_484"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/url-blocking/get-controls-blockedurls"}],"panels":[]}]},"httpPath":"/v1/controls/blockedUrls"},{"label":"Add a new blocked URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/url-blocking/post-controls-blockedurls","routeSlug":"/rest-v1/url-blocking/post-controls-blockedurls","metadata":{"seo":{"title":"Add a new blocked URL","description":"Add a new blocked URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"post-controls-blockedUrls","name":"Add a new blocked URL","isWebhook":false,"pointer":"/paths/~1v1~1controls~1blockedUrls/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new blocked URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485","exampleIds":["paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"]}},"schemaId":"schema_485","exampleIds":["paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"],"pointer":"/paths/~1v1~1controls~1blockedUrls/post/requestBody","description":"A URL pattern used to block access to matching sites. A maximum of 2,000 blocked URLs is supported."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/controls/blockedUrls","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_485","exampleIds":["paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"]}},"responseCodes":["200","400"],"pointer":"/v1/controls/blockedUrls","href":"url-blocking/post-controls-blockedurls","openApiOperationId":"post-controls-blockedUrls","summary":"Add a new blocked URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"schema_485","exampleIds":["paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_485","exampleIds":["paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain","paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockedURL"}},"schemaId":"components/schemas/BlockedURL","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1controls~1blockedUrls/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlockedURL","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlockedURL"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/url-blocking/post-controls-blockedurls"}],"panels":[]}]},"httpPath":"/v1/controls/blockedUrls"},{"label":"Delete all blocked URLs","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/url-blocking/delete-controls-blockedurls","routeSlug":"/rest-v1/url-blocking/delete-controls-blockedurls","metadata":{"seo":{"title":"Delete all blocked URLs","description":"Delete all blocked URLs"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-controls-blockedUrls","name":"Delete all blocked URLs","isWebhook":false,"pointer":"/paths/~1v1~1controls~1blockedUrls/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all blocked URLs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/controls/blockedUrls","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/controls/blockedUrls","href":"url-blocking/delete-controls-blockedurls","openApiOperationId":"delete-controls-blockedUrls","summary":"Delete all blocked URLs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","headers":{}},{"code":"400","description":"Bad Request"}],"pointer":"/paths/~1v1~1controls~1blockedUrls/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/url-blocking/delete-controls-blockedurls"}],"panels":[]}]},"httpPath":"/v1/controls/blockedUrls"}],"content":{"contentType":"group","meta":{"name":"URL blocking"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"URL blocking","showPageActions":true},{"nodeType":"markdoc","content":"These objects represent the blocked URLs configured in your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/controls/blockedUrls","summary":"List all blocked URLs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/url-blocking/get-controls-blockedurls","deprecated":false},{"title":"/v1/controls/blockedUrls","summary":"Add a new blocked URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/url-blocking/post-controls-blockedurls","deprecated":false},{"title":"/v1/controls/blockedUrls","summary":"Delete all blocked URLs","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/url-blocking/delete-controls-blockedurls","deprecated":false}]}]}]}]}},{"type":"separator","label":"Telemetry","content":null},{"type":"group","label":"File download","link":"/rest-v1/file-download","routeSlug":"/rest-v1/file-download","items":[{"label":"Retrieve the file download telemetry configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-download/get-telemetry-filedownload","routeSlug":"/rest-v1/file-download/get-telemetry-filedownload","metadata":{"seo":{"title":"Retrieve the file download telemetry configuration","description":"Returns your organization's current file download telemetry configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-telemetry-fileDownload","name":"Retrieve the file download telemetry configuration","isWebhook":false,"pointer":"/paths/~1v1~1telemetry~1fileDownload~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the file download telemetry configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current file download telemetry configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/telemetry/fileDownload/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/telemetry/fileDownload/configuration","href":"file-download/get-telemetry-filedownload","openApiOperationId":"get-telemetry-fileDownload","summary":"Retrieve the file download telemetry configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig"}},"schemaId":"components/schemas/FileDownloadTelemetryConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1telemetry~1fileDownload~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDownloadTelemetryConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-download/get-telemetry-filedownload"}],"panels":[]}]},"httpPath":"/v1/telemetry/fileDownload/configuration"},{"label":"Replace the file download telemetry configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-download/put-telemetry-filedownload","routeSlug":"/rest-v1/file-download/put-telemetry-filedownload","metadata":{"seo":{"title":"Replace the file download telemetry configuration","description":"Replaces your organization's file download telemetry configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-telemetry-fileDownload","name":"Replace the file download telemetry configuration","isWebhook":false,"pointer":"/paths/~1v1~1telemetry~1fileDownload~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the file download telemetry configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's file download telemetry configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"schemaId":"components/schemas/FileDownloadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"],"pointer":"/paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/telemetry/fileDownload/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/telemetry/fileDownload/configuration","href":"file-download/put-telemetry-filedownload","openApiOperationId":"put-telemetry-fileDownload","summary":"Replace the file download telemetry configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/FileDownloadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig"}},"schemaId":"components/schemas/FileDownloadTelemetryConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1telemetry~1fileDownload~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileDownloadTelemetryConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileDownloadTelemetryConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-download/put-telemetry-filedownload"}],"panels":[]}]},"httpPath":"/v1/telemetry/fileDownload/configuration"}],"content":{"contentType":"group","meta":{"name":"File download"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File download","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that control file download telemetry collection across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/telemetry/fileDownload/configuration","summary":"Retrieve the file download telemetry configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-download/get-telemetry-filedownload","deprecated":false},{"title":"/v1/telemetry/fileDownload/configuration","summary":"Replace the file download telemetry configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/file-download/put-telemetry-filedownload","deprecated":false}]}]}]}]}},{"type":"group","label":"File upload","link":"/rest-v1/file-upload","routeSlug":"/rest-v1/file-upload","items":[{"label":"Retrieve the file upload telemetry configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-upload/get-telemetry-fileupload","routeSlug":"/rest-v1/file-upload/get-telemetry-fileupload","metadata":{"seo":{"title":"Retrieve the file upload telemetry configuration","description":"Returns your organization's current file upload telemetry configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-telemetry-fileUpload","name":"Retrieve the file upload telemetry configuration","isWebhook":false,"pointer":"/paths/~1v1~1telemetry~1fileUpload~1configuration/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the file upload telemetry configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns your organization's current file upload telemetry configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first."},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/telemetry/fileUpload/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/telemetry/fileUpload/configuration","href":"file-upload/get-telemetry-fileupload","openApiOperationId":"get-telemetry-fileUpload","summary":"Retrieve the file upload telemetry configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig"}},"schemaId":"components/schemas/FileUploadTelemetryConfig"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1telemetry~1fileUpload~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadTelemetryConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload/get-telemetry-fileupload"}],"panels":[]}]},"httpPath":"/v1/telemetry/fileUpload/configuration"},{"label":"Replace the file upload telemetry configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/rest-v1/file-upload/put-telemetry-fileupload","routeSlug":"/rest-v1/file-upload/put-telemetry-fileupload","metadata":{"seo":{"title":"Replace the file upload telemetry configuration","description":"Replaces your organization's file upload telemetry configuration with theconfiguration you send. Any rule you don't include is deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"put-telemetry-fileUpload","name":"Replace the file upload telemetry configuration","isWebhook":false,"pointer":"/paths/~1v1~1telemetry~1fileUpload~1configuration/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace the file upload telemetry configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces your organization's file upload telemetry configuration with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration you send. Any rule you don't include is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A rule with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates the existing rule with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A rule without"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Rules are evaluated in the order you send them, and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first rule that matches wins."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To change part of the configuration, retrieve it first, apply your changes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and send the complete configuration back."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"x-api-key","scopes":[],"type":"apiKey","in":"header","paramName":"x-api-key","description":"API key authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"schemaId":"components/schemas/FileUploadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"],"pointer":"/paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody","description":"The complete set of rules to save."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/telemetry/fileUpload/configuration","servers":[{"url":"https://api.pushsecurity.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"x-api-key","type":"apiKey","name":"x-api-key","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"responseCodes":["200","400","403","404"],"pointer":"/v1/telemetry/fileUpload/configuration","href":"file-upload/put-telemetry-fileupload","openApiOperationId":"put-telemetry-fileUpload","summary":"Replace the file upload telemetry configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.pushsecurity.com"}],"schemaId":"components/schemas/FileUploadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig","exampleIds":["paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules","paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig"}},"schemaId":"components/schemas/FileUploadTelemetryConfig"},{"code":"400","description":"Bad Request"},{"code":"403","description":"Forbidden (read-only API key)"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1telemetry~1fileUpload~1configuration/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadTelemetryConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadTelemetryConfig"}}},{"code":"400"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload/put-telemetry-fileupload"}],"panels":[]}]},"httpPath":"/v1/telemetry/fileUpload/configuration"}],"content":{"contentType":"group","meta":{"name":"File upload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File upload","showPageActions":true},{"nodeType":"markdoc","content":"Manage the rules that control file upload telemetry collection across your organization."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/telemetry/fileUpload/configuration","summary":"Retrieve the file upload telemetry configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-upload/get-telemetry-fileupload","deprecated":false},{"title":"/v1/telemetry/fileUpload/configuration","summary":"Replace the file upload telemetry configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/file-upload/put-telemetry-fileupload","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EmployeeInList":{"id":"components/schemas/EmployeeInList","kind":"json-schema","title":"Employee","data":{"title":"Employee","type":"object","nullable":false,"description":"This object represents an employee in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the employee","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"Primary email address of the employee","format":"email","example":"john.hill@example.com"},"firstName":{"type":"string","description":"First name of the employee","example":"John"},"lastName":{"type":"string","description":"Last name of the employee","example":"Hill"},"department":{"type":"string","description":"Department - as provided by connected API integrations","example":"Security Engineering"},"location":{"type":"string","description":"Location - as provided by connected API integrations","example":"New York"},"licensed":{"type":"boolean","description":"Whether the employee is licensed on the Push platform","example":true},"chatopsEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the employee has ChatOps enabled"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version."},"children":[]}]}]}]}],"example":true,"deprecated":true},"groups":{"type":"array","description":"Groups the employee is in","items":{"type":"string"},"example":["engineering","marketing"]},"creationTimestamp":{"type":"integer","description":"When this employee was created, formatted as a UNIX timestamp (in seconds)","example":1698669223}}}},"components/schemas/EmployeeInEvent":{"id":"components/schemas/EmployeeInEvent","kind":"json-schema","title":"Employee","data":{"title":"Employee","type":"object","description":"This object represents an employee in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the employee","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"Primary email address of the employee","format":"email","example":"john.hill@example.com"},"firstName":{"type":"string","description":"First name of the employee","example":"John"},"lastName":{"type":"string","description":"Last name of the employee","example":"Hill"},"department":{"type":"string","description":"Department - as provided by connected API integrations","example":"Security Engineering"},"location":{"type":"string","description":"Location - as provided by connected API integrations","example":"New York"},"licensed":{"type":"boolean","description":"Whether the employee is licensed on the Push platform","example":true},"chatopsEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the employee has ChatOps enabled"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version."},"children":[]}]}]}]}],"example":true,"deprecated":true},"creationTimestamp":{"type":"integer","description":"When this employee was created, formatted as a UNIX timestamp (in seconds)","example":1698669223}}}},"components/schemas/Employee":{"id":"components/schemas/Employee","kind":"json-schema","title":"Employee","data":{"title":"Employee","type":"object","nullable":false,"description":"This object represents an employee in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the employee","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"Primary email address of the employee","format":"email","example":"john.hill@example.com"},"knownEmails":{"type":"array","description":"All the known email addresses of the employee","items":{"type":"string"},"example":["john.hill@example.com","jhill@example.com"]},"firstName":{"type":"string","description":"First name of the employee","example":"John"},"lastName":{"type":"string","description":"Last name of the employee","example":"Hill"},"department":{"type":"string","description":"Department - as provided by connected API integrations","example":"Security Engineering"},"location":{"type":"string","description":"Location - as provided by connected API integrations","example":"New York"},"licensed":{"type":"boolean","description":"Whether the employee is licensed on the Push platform","example":true},"chatopsEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the employee has ChatOps enabled"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version."},"children":[]}]}]}]}],"example":true,"deprecated":true},"groups":{"type":"array","description":"Groups the employee is in","items":{"type":"string"},"example":["engineering","marketing"]},"creationTimestamp":{"type":"integer","description":"When this employee was created, formatted as a UNIX timestamp (in seconds)","example":1698669223}}}},"components/schemas/MfaMethodsType":{"id":"components/schemas/MfaMethodsType","kind":"json-schema","title":"MfaMethodsType","data":{"title":"MfaMethodsType","type":"string","enum":["APP_TOTP","PUSH_NOTIFICATION","EMAIL_OTP","U2F","HARDWARE_TOTP","PHONE_CALL","SMS_OTP","APP_PASSWORD","GRID_CARD","EXTERNAL_PROVIDER","BACKUP_CODES","WEBAUTHN"],"x-enumDescriptions":{"APP_TOTP":"Time-based one-time password via app","PUSH_NOTIFICATION":"Authentication prompt on device","EMAIL_OTP":"One-time password sent to email","U2F":"Physical security key","HARDWARE_TOTP":"Time-based password via hardware token","PHONE_CALL":"Voice verification","SMS_OTP":"One-time password sent via SMS","APP_PASSWORD":"Specialized password for app access","GRID_CARD":"Reference card with codes","EXTERNAL_PROVIDER":"Third-party authentication service","BACKUP_CODES":"Pre-generated one-time codes","WEBAUTHN":"Two-factor authentication with biometrics support"},"description":"All possible ENUM values for MfaMethods"}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"title":"Account","type":"object","description":"This object represents an account in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the account","example":"d6a32ba5-0532-4a66-8137-48cdf409c972"},"employeeId":{"type":"string","description":"Identifier of primary employee that this account belongs to","example":"72d0347a-2663-4ef5-b1c5-df39163f1603"},"appType":{"type":"string","description":"The app associated with this account","example":"ATLASSIAN"},"appId":{"type":"string","description":"The ID of the app associated with this account","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"The email address used to log into the account","format":"email","example":"john.hill@example.com"},"mfaRegistered":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether MFA is registered or not. If unknown, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}],"nullable":true,"example":true},"mfaMethods":{"type":"array","items":{"$ref":"#/components/schemas/MfaMethodsType"},"description":"The MFA methods registered for this account","nullable":true},"passwordId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the password used on this account. The actual password is not sent up by the browser extension and so this is an identifier for it instead. This value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if password authentication is not used."},"children":[]}]}]}],"nullable":true,"example":"4c13674f-e88a-4411-bfa2-53a70468a898"},"loginMethods":{"type":"object","properties":{"passwordLogin":{"type":"boolean","description":"Whether or not this account has been logged into with a password","example":true},"lastPasswordLoginTimestamp":{"type":"integer","description":"When the account was last logged into using a password, formatted as a UNIX timestamp (in seconds)","example":1698064423},"oidcLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do an OIDC login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no OIDC login has been performed."},"children":[]}]}]}],"nullable":true,"example":"GOOGLE_WORKSPACE"},"lastOidcLoginTimestamp":{"type":"integer","description":"When the account was last logged into using OIDC, formatted as a UNIX timestamp (in seconds)","example":1698064423},"samlLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do a SAML login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no SAML login has been performed."},"children":[]}]}]}],"nullable":true,"example":"OKTA"},"lastSamlLoginTimestamp":{"type":"integer","description":"When the account was last logged into using SAML, formatted as a UNIX timestamp (in seconds)","example":1698064423},"oktaSwaLogin":{"type":"boolean","description":"Whether or not this account has been logged into with Okta SWA","example":true},"lastOktaSwaLoginTimestamp":{"type":"integer","description":"When the account was last logged into using Okta SWA, formatted as a UNIX timestamp (in seconds)","example":1698064423},"vendorSsoLogin":{"type":"string","description":"Whether or not this account has an associated vendor SSO provider.","nullable":true,"example":"GOOGLE_WORKSPACE"},"fedCmLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do a FedCM login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no FedCM login has been performed."},"children":[]}]}]}],"nullable":true,"example":"GOOGLE_WORKSPACE"},"lastFedCmLoginTimestamp":{"type":"integer","description":"When the account was last logged into using FedCM, formatted as a UNIX timestamp (in seconds)","example":1698064423}}},"creationTimestamp":{"type":"integer","description":"When this account was created, formatted as a UNIX timestamp (in seconds)","example":1698064423},"lastUsedTimestamp":{"type":"integer","nullable":true,"description":"When the account was last used by an employee, formatted as a UNIX timestamp (in seconds)","example":1698669168}}}},"components/schemas/DeleteAccount":{"id":"components/schemas/DeleteAccount","kind":"json-schema","title":"Remove Account","data":{"title":"Remove Account","type":"object","description":"This object represents a removed account in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the account","example":"d6a32ba5-0532-4a66-8137-48cdf409c972"},"object":{"type":"string","description":"The type of object that has been removed by this operation","example":"ACCOUNT"},"deleted":{"type":"boolean","description":"Whether the account has been successfully removed or not","example":true}}}},"components/schemas/AccountUser":{"id":"components/schemas/AccountUser","kind":"json-schema","title":"Account User","data":{"title":"Account User","type":"object","description":"This object represents an employee in your organization.","properties":{"employeeId":{"type":"string","description":"Identifier of the employee has access to this account","example":"bf4cf562-7830-41ac-80e3-d261da1c9bb9"},"lastUsedTimestamp":{"type":"integer","nullable":true,"description":"When the account was last used by an employee, formatted as a UNIX timestamp (in seconds)","example":1698669223},"passwordManuallyTyped":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the password was manually typed (or a password manager was used) on the last login. This value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if password authentication is not used"},"children":[]}]}]}],"example":true}}}},"components/schemas/ApprovalStatusType":{"id":"components/schemas/ApprovalStatusType","kind":"json-schema","title":"ApprovalStatusType","data":{"title":"ApprovalStatusType","type":"string","enum":["UNDER_REVIEW","APPROVED","NOT_APPROVED"],"x-enumDescriptions":{"UNDER_REVIEW":"The app is under review","APPROVED":"The app has been approved","NOT_APPROVED":"The app has not been approved"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approval status of the app, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not set"},"children":[]}]}]}],"nullable":true}},"components/schemas/SensitivityLevelType":{"id":"components/schemas/SensitivityLevelType","kind":"json-schema","title":"SensitivityLevelType","data":{"title":"SensitivityLevelType","type":"string","enum":["HIGH","MEDIUM","LOW"],"x-enumDescriptions":{"HIGH":"The sensitivity of the app is high","MEDIUM":"The sensitivity of the app is medium","LOW":"The sensitivity of the app is low"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sensitivity level of the app, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not set"},"children":[]}]}]}],"nullable":true}},"components/schemas/AppCategory":{"id":"components/schemas/AppCategory","kind":"json-schema","title":"AppCategory","data":{"title":"AppCategory","type":"object","description":"A category associated with an app.","required":["code","name","group"],"properties":{"code":{"type":"integer","description":"Numeric code identifying the category","example":83},"name":{"type":"string","description":"Name of the category","example":"AI/ML Applications"},"group":{"type":"string","description":"The group this category belongs to","example":"Technology"}}}},"components/schemas/App":{"id":"components/schemas/App","kind":"json-schema","title":"App","data":{"title":"App","type":"object","description":"This object represents an app in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for this object","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"type":{"type":"string","description":"The type of app, formatted as an ENUM value.","example":"ZAPIER"},"approvalStatus":{"$ref":"#/components/schemas/ApprovalStatusType"},"sensitivityLevel":{"$ref":"#/components/schemas/SensitivityLevelType"},"ownerId":{"type":"string","description":"Identifier of the employee who is the owner of this platform","example":"87569da6-fb7a-4df7-8ce2-246c14044911","nullable":true},"notes":{"type":"string","description":"Notes recorded on this app","example":"Last security audit: 16 January 2023"},"website":{"type":"string","description":"URL to the app's homepage","example":"https://zapier.com/"},"description":{"type":"string","description":"Description of the app's purpose","example":"Zapier is a cloud-based automation tool that enables users to integrate and automate various web applications without requiring extensive coding knowledge, potentially streamlining workflows and processes."},"friendlyName":{"type":"string","description":"The friendly name of the app","example":"Zapier"},"labels":{"type":"array","description":"Labels associated with this app","items":{"type":"string"},"example":["GenAI","marketing"]},"categories":{"type":"array","description":"Categories associated with this app","items":{"$ref":"#/components/schemas/AppCategory"}},"creationTimestamp":{"type":"integer","description":"When the app was first observed, formatted as a UNIX timestamp (in seconds)","example":1698064423}}}},"components/schemas/BrowserType":{"id":"components/schemas/BrowserType","kind":"json-schema","title":"BrowserType","data":{"title":"BrowserType","enum":["CHROME","FIREFOX","EDGE","SAFARI","OPERA","BRAVE","ARC","ISLAND","PRISMA_ACCESS","ATLAS","COMET","DIA","UNKNOWN"],"description":"The browser used by the employee"}},"components/schemas/OSType":{"id":"components/schemas/OSType","kind":"json-schema","title":"OSType","data":{"title":"OSType","enum":["MACOS","WINDOWS","LINUX","CHROME_OS","IOS","ANDROID","UNKNOWN"],"description":"The OS used by the employee"}},"components/schemas/Browser":{"id":"components/schemas/Browser","kind":"json-schema","title":"Browser","data":{"title":"Browser","type":"object","nullable":true,"description":"This object represents a browser of an employee in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the browser","example":"1852b6ab-0cca-4c8d-8f14-4905497504ec"},"employeeId":{"type":"string","description":"Unique identifier for the employee","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"Email address of the employee","format":"email","example":"john.hill@example.com"},"version":{"type":"string","description":"Version of the browser","example":"125.0.0.0"},"tokenType":{"type":"string","description":"Type of enrollment token used","enum":["INDIVIDUAL","TEAM","LANDING_PAGE"]},"isActive":{"type":"boolean","description":"Whether the browser extension is used by a licensed employee","example":true},"browser":{"$ref":"#/components/schemas/BrowserType"},"os":{"$ref":"#/components/schemas/OSType"},"extensionVersion":{"type":"string","description":"Version of the Push extension","example":"1.66.17"},"language":{"type":"string","description":"The browser language","example":"en-US"},"profileEmail":{"type":"string","description":"The email address of the signed in browser profile","format":"email","example":"john.hill@example.com"},"profileSyncEnabled":{"type":"boolean","description":"Whether synchronisation is enabled on the browser profile","example":true},"creationTimestamp":{"type":"integer","description":"When this browser object was created, formatted as a UNIX timestamp (in seconds)","example":1698669223},"lastOnlineTimestamp":{"type":"integer","description":"When this browser was last seen, formatted as a UNIX timestamp (in seconds)","example":1716290202}}}},"components/schemas/DeploymentMode":{"id":"components/schemas/DeploymentMode","kind":"json-schema","title":"DeploymentMode","data":{"title":"DeploymentMode","type":"string","enum":["MANAGED","DEVELOPMENT","MANUAL","SIDELOAD","OTHER"],"description":"Which method was used to install this extension"}},"components/schemas/BrowserExtension":{"id":"components/schemas/BrowserExtension","kind":"json-schema","title":"BrowserExtension","data":{"title":"BrowserExtension","type":"object","description":"This object represents a browser extension in your organization.","properties":{"id":{"type":"string","description":"Unique ID of this browser extension record","example":"72d0347a-2663-4ef5-b1c5-df39163f1603"},"extensionId":{"type":"string","description":"Static identifier for the extension.","example":"gmbgaklkmjakoegficnlkhebmhkjfich"},"employeeId":{"type":"string","description":"Identifier of primary employee that this extension belongs to","example":"72d0347a-2663-4ef5-b1c5-df39163f1603"},"browserId":{"type":"string","description":"Identifier of the employee's Push extension","example":"72d0347a-2663-4ef5-b1c5-df39163f1603"},"name":{"type":"string","description":"Name of the browser extension","example":"Privacy Badger"},"description":{"type":"string","description":"Description of the browser extension","example":"Privacy Badger automatically learns to block invisible trackers."},"deploymentMode":{"$ref":"#/components/schemas/DeploymentMode"},"permissions":{"type":"array","description":"Permissions required by the browser extension","items":{"type":"string"},"example":["activeTab","contextMenus","storage"]},"hostPermissions":{"type":"array","description":"Host permissions allow extensions to interact with the URLs matching these patterns.","items":{"type":"string"},"example":["https://*/*","http://*/*"]},"version":{"type":"string","description":"Version of the browser extension","example":"3.1.5.2"},"versionName":{"type":"string","description":"Version number shown to the user","example":"build rc2"},"enabled":{"type":"boolean","description":"Whether the browser extension is enabled","example":true},"disabledReason":{"type":"string","description":"Reason why the browser extension was disabled","example":"NEW_PERMISSION_REQUIRED"},"updateUrl":{"type":"string","description":"The URL where the browser extension gets updates from","example":"http://clients2.google.com/service/update2/crx"},"homePageUrl":{"type":"string","description":"Link to the browser extensions home page","example":"http://www.eff.org/"},"creationTimestamp":{"type":"integer","description":"When this browser extension was created, formatted as a UNIX timestamp (in seconds)","example":1698064423},"lastUpdatedTimestamp":{"type":"integer","description":"When the browser extension was last used by an employee, formatted as a UNIX timestamp (in seconds)","example":1698064423}}}},"components/schemas/ControlConfigCondition":{"id":"components/schemas/ControlConfigCondition","kind":"json-schema","title":"Match Condition","data":{"title":"Match Condition","type":"object","description":"Narrows a rule to a set of values, and whether to apply the rule to those values or to everything except them.","properties":{"matches":{"type":"array","items":{"type":"string"},"minItems":1,"description":"One or more values to match."},"action":{"type":"string","enum":["INCLUDE","EXCLUDE"],"default":"INCLUDE","description":"Apply the rule to the matched values (INCLUDE) or to everything except them (EXCLUDE). Defaults to INCLUDE when omitted."}},"required":["matches"]}},"components/schemas/AppCategoryId":{"id":"components/schemas/AppCategoryId","kind":"json-schema","title":"App Category ID","data":{"title":"App Category ID","type":"string","description":"A category ID describing the type of app, sent as a string.","example":"9","enum":["2","5","6","7","8","9","10","12","14","16","17","18","20","21","23","25","26","29","30","31","34","35","36","37","41","42","43","45","46","53","56","57","58","59","60","61","62","64","66","67","68","69","71","73","75","76","77","78","79","81","83","84","85"],"x-enumDescriptions":{"2":"Ads/Analytics","5":"Arts/Culture","6":"Auctions/Classifieds","7":"Audio","8":"Brokerage/Trading","9":"Business/Economy","10":"Chat/IM/SMS","12":"Content Servers","14":"Digital Postcards","16":"Education","17":"Email","18":"Entertainment","20":"File Sharing/Storage","21":"Finance","23":"Forums","25":"Games","26":"Government/Legal","29":"Health","30":"Hobbies/Recreation","31":"Hosting","34":"Information Technology","35":"Information/Computer Security","36":"Infrastructure/IOT","37":"Job Search","41":"Marketing/Merchandising","42":"Media Sharing","43":"Military","45":"News","46":"Non-Profit/Advocacy","53":"Politics/Opinion","56":"Productivity Applications","57":"Anonymizers","58":"Real Estate","59":"Reference","60":"Religion","61":"Remote Access","62":"Restaurants/Food","64":"Search Engines/Portals","66":"Shopping","67":"Social Networking","68":"Society/Lifestyle","69":"Software Downloads","71":"Sports","73":"Telephony","75":"Translation","76":"Travel","77":"URL Redirect","78":"Vehicles","79":"Video/Multimedia","81":"Virtual Meetings","83":"AI/ML Applications","84":"Alternative Currency","85":"Dynamic DNS"}}},"components/schemas/AppCategoriesCondition":{"id":"components/schemas/AppCategoriesCondition","kind":"json-schema","title":"App Categories","data":{"title":"App Categories","type":"object","description":"Narrows a rule to a set of app categories. These values are always included, so this condition does not take an action.","properties":{"matches":{"type":"array","items":{"$ref":"#/components/schemas/AppCategoryId"},"minItems":1,"description":"One or more app category IDs to match."}},"required":["matches"]}},"components/schemas/ApprovalStatusesCondition":{"id":"components/schemas/ApprovalStatusesCondition","kind":"json-schema","title":"Approval Statuses","data":{"title":"Approval Statuses","type":"object","description":"Narrows a rule to a set of app approval statuses, and whether to apply the rule to those statuses or to everything except them.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["UNDER_REVIEW","APPROVED","NOT_APPROVED","NOT_REVIEWED"],"x-enumDescriptions":{"UNDER_REVIEW":"The app is under review","APPROVED":"The app has been approved","NOT_APPROVED":"The app has not been approved","NOT_REVIEWED":"The app has no approval status set"}},"minItems":1,"description":"One or more approval statuses to match."},"action":{"type":"string","enum":["INCLUDE","EXCLUDE"],"default":"INCLUDE","description":"Apply the rule to the matched values (INCLUDE) or to everything except them (EXCLUDE). Defaults to INCLUDE when omitted."}},"required":["matches"]}},"components/schemas/SensitivityLevelsCondition":{"id":"components/schemas/SensitivityLevelsCondition","kind":"json-schema","title":"Sensitivity Levels","data":{"title":"Sensitivity Levels","type":"object","description":"Narrows a rule to a set of app sensitivity levels, and whether to apply the rule to those levels or to everything except them.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["HIGH","MEDIUM","LOW","NOT_REVIEWED"],"x-enumDescriptions":{"HIGH":"The sensitivity of the app is high","MEDIUM":"The sensitivity of the app is medium","LOW":"The sensitivity of the app is low","NOT_REVIEWED":"The app has no sensitivity level set"}},"minItems":1,"description":"One or more sensitivity levels to match."},"action":{"type":"string","enum":["INCLUDE","EXCLUDE"],"default":"INCLUDE","description":"Apply the rule to the matched values (INCLUDE) or to everything except them (EXCLUDE). Defaults to INCLUDE when omitted."}},"required":["matches"]}},"components/schemas/AppBannerConfig":{"id":"components/schemas/AppBannerConfig","kind":"json-schema","title":"App Banner Configuration","data":{"title":"App Banner Configuration","type":"object","description":"Complete set of App Banner configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of App Banner rules.","items":{"title":"App Banner Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn Finance about risky apps"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["INFORM","ACKNOWLEDGE","REASON","BLOCK","DO_NOT_SHOW"],"description":"What banner (if any) is shown when the rule matches.","x-enumDescriptions":{"INFORM":"Show an informational banner. Requires title and subtext.","ACKNOWLEDGE":"Show a banner the user must acknowledge with a button. Requires title, subtext and buttonText.","REASON":"Show a banner asking the user to provide a reason. Requires title, subtext and buttonText.","BLOCK":"Block the app and show a banner. Requires title, subtext and allowReasonSubmission; buttonText is required when allowReasonSubmission is true.","DO_NOT_SHOW":"Show no banner. All other settings are ignored."},"example":"ACKNOWLEDGE"},"title":{"type":"string","maxLength":75,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Heading shown to the user. Required for every mode except DO_NOT_SHOW."},"children":[]}]}]}],"example":"Approved apps only"},"subtext":{"type":"string","maxLength":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message shown to the user. Markdown is supported. Required for every mode except DO_NOT_SHOW."},"children":[]}]}]}],"example":"Please only use apps approved by IT."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the banner's action button. Required for modes ACKNOWLEDGE and REASON, and for BLOCK when allowReasonSubmission is true. Must not be set for mode INFORM.","example":"I understand"},"allowReasonSubmission":{"type":"boolean","description":"Whether the user may submit a reason. Only valid for mode BLOCK, where it is required.","example":true},"displayFrequency":{"type":"string","enum":["ONCE_PER_BROWSER","ONCE_PER_TAB"],"description":"How often the banner is shown to a matching user.","x-enumDescriptions":{"ONCE_PER_BROWSER":"Show the banner once per browser.","ONCE_PER_TAB":"Show the banner once per tab."},"example":"ONCE_PER_BROWSER"},"criteria":{"title":"App Banner Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"appTypes":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match apps by their type.","example":{"matches":["OKTA"]}},"appLabels":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match apps by the labels applied to them.","example":{"matches":["Sanctioned"]}},"appCategories":{"allOf":[{"$ref":"#/components/schemas/AppCategoriesCondition"}],"description":"Match apps by their category.","example":{"matches":["9"]}},"approvalStatuses":{"allOf":[{"$ref":"#/components/schemas/ApprovalStatusesCondition"}],"description":"Match apps by their approval status.","example":{"matches":["APPROVED"]}},"sensitivityLevels":{"allOf":[{"$ref":"#/components/schemas/SensitivityLevelsCondition"}],"description":"Match apps by their sensitivity level.","example":{"matches":["HIGH"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/ControlConfigIncludeCondition":{"id":"components/schemas/ControlConfigIncludeCondition","kind":"json-schema","title":"Match Condition (include only)","data":{"title":"Match Condition (include only)","type":"object","description":"Narrows a rule to a set of values. These values are always included, so this condition does not take an action.","properties":{"matches":{"type":"array","items":{"type":"string"},"minItems":1,"description":"One or more values to match."}},"required":["matches"]}},"components/schemas/AppBannerUrlPatternConfig":{"id":"components/schemas/AppBannerUrlPatternConfig","kind":"json-schema","title":"App Banner (URL Pattern) Configuration","data":{"title":"App Banner (URL Pattern) Configuration","type":"object","description":"Complete set of App Banner (URL Pattern) configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of App Banner (URL Pattern) rules.","items":{"title":"App Banner (URL Pattern) Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn on internal admin portal"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["INFORM","ACKNOWLEDGE","REASON","BLOCK","DO_NOT_SHOW"],"description":"What banner, if any, the user sees on a matching page.","x-enumDescriptions":{"INFORM":"Show an informational banner set by title and subtext.","ACKNOWLEDGE":"Show a banner the user must dismiss with the acknowledgement button set by buttonText.","REASON":"Show a banner that requires the user to submit a reason before continuing, using the button set by buttonText.","BLOCK":"Block the page and show the message set by title and subtext. allowReasonSubmission controls whether the user may submit a reason to proceed.","DO_NOT_SHOW":"Show no banner."},"example":"INFORM"},"title":{"type":"string","maxLength":75,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Heading shown to the user. Required for every mode except DO_NOT_SHOW."},"children":[]}]}]}],"example":"Handle with care"},"subtext":{"type":"string","maxLength":1000,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message shown to the user. Markdown is supported. Required for every mode except DO_NOT_SHOW."},"children":[]}]}]}],"example":"This is an internal admin tool. Do not paste customer data."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the banner's button. Required for ACKNOWLEDGE and REASON, and for BLOCK when allowReasonSubmission is true. Must be omitted for INFORM.","example":"I understand"},"allowReasonSubmission":{"type":"boolean","description":"Whether the user may submit a reason to proceed. Only valid for, and required by, mode BLOCK.","example":false},"displayFrequency":{"type":"string","enum":["ONCE_PER_BROWSER","ONCE_PER_TAB"],"description":"How often the banner is shown to a user.","x-enumDescriptions":{"ONCE_PER_BROWSER":"Show the banner once per browser.","ONCE_PER_TAB":"Show the banner once per tab."},"example":"ONCE_PER_BROWSER"},"criteria":{"title":"App Banner (URL Pattern) Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"urlPatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match pages by URL pattern. Each pattern must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*://*.example.com/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"matches":["*://*.example.com/"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/BlockedURL":{"id":"components/schemas/BlockedURL","kind":"json-schema","title":"Blocked URL","data":{"title":"Blocked URL","type":"string","description":"This object represents a URL pattern used to block access to matching sites.","example":"*://*.example.com/*"}},"components/schemas/ControlsBlockedUrlsHostPath":{"id":"components/schemas/ControlsBlockedUrlsHostPath","kind":"json-schema","title":"ControlsBlockedUrlsHostPath","data":{"type":"object","properties":{"host":{"type":"string","description":"The host part of the URL pattern. This can be a domain or a subdomain. Wildcards are supported for subdomains.","example":"*.sub.domain.com"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path part of the URL pattern. Wildcards are supported. If not specified, the wildcard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed, matching all paths for the given host."},"children":[]}]}]}],"example":"/path/to*"}},"required":["host"]}},"components/schemas/ControlsBlockedUrlsUrl":{"id":"components/schemas/ControlsBlockedUrlsUrl","kind":"json-schema","title":"ControlsBlockedUrlsUrl","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The whole URL pattern - a combination of host and path. The host can be a domain or a subdomain. Wildcards are supported for subdomains and path. If not specified, the wildcard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is assumed for path, matching all paths for the derived host."},"children":[]}]}]}],"example":"*.sub.domain.com/path/to*"}},"required":["url"]}},"components/schemas/BrowserExtensionBlockingConfig":{"id":"components/schemas/BrowserExtensionBlockingConfig","kind":"json-schema","title":"Browser Extension Blocking Configuration","data":{"title":"Browser Extension Blocking Configuration","type":"object","description":"Complete set of Browser Extension Blocking configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of Browser Extension Blocking rules.","items":{"title":"Browser Extension Blocking Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Block risky extensions for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","ENABLE","BLOCK"],"description":"What happens to the browser extensions a rule matches.","x-enumDescriptions":{"OFF":"Take no action.","ENABLE":"Force-enable the matching extensions.","BLOCK":"Block the matching extensions and show the message set by title and subtext."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user when an extension is blocked. Required when mode is BLOCK.","example":"Extension blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user when an extension is blocked. Markdown is supported. Required when mode is BLOCK.","example":"This extension is not permitted on company devices."},"criteria":{"title":"Browser Extension Blocking Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"browserExtensionProfile":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match extensions by the browser profile they are installed in. One of ALL, COMPANY_DOMAINS, or NON_COMPANY_DOMAINS."},"children":[]}]}]}],"example":{"matches":["ALL"]}},"browserExtensions":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific extensions by their extension ID, such as a 32-character Chrome extension ID.","example":{"matches":["abcdefghijklmnopabcdefghijklmnop"]}},"browserExtensionPermissions":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match extensions by the browser permissions they request.","example":{"matches":["cookies","<all_urls>"]}},"browserExtensionDeploymentType":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match extensions by how they were installed. One of DEVELOPMENT, MANAGED, MANUAL, OTHER, SIDELOAD, or UNKNOWN.","example":{"matches":["SIDELOAD"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/ClipboardBlockingConfig":{"id":"components/schemas/ClipboardBlockingConfig","kind":"json-schema","title":"Clipboard Blocking Configuration","data":{"title":"Clipboard Blocking Configuration","type":"object","description":"Complete set of Clipboard Blocking configuration.","properties":{"globals":{"title":"Clipboard Blocking Globals","type":"object","description":"Control-wide settings that apply across every rule.","properties":{"customContentPatterns":{"type":"array","maxItems":250,"description":"Your organization's custom content patterns for matching clipboard content, available to every rule alongside the Push-defined pattern catalogue.","items":{"title":"Custom Content Pattern","type":"object","properties":{"enum":{"type":"string","description":"Identifier that rules use to reference the pattern in criteria.regexPatterns. Derived automatically from the name.","example":"CUSTOM_INCIDENT_TICKET"},"name":{"type":"string","maxLength":60,"description":"A short name to help you recognise the pattern.","example":"Incident ticket"},"regex":{"type":"string","maxLength":1024,"description":"The regular expression to match clipboard content against.","example":"INC-\\d{6}"}},"required":["name","regex"]},"example":[{"enum":"CUSTOM_INCIDENT_TICKET","name":"Incident ticket","regex":"INC-\\d{6}"}]}}},"rules":{"type":"array","description":"Complete list of Clipboard Blocking rules.","items":{"title":"Clipboard Blocking Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn when copying incident tickets"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","MONITOR","WARN","BLOCK"],"description":"What happens when clipboard content matches the rule.","x-enumDescriptions":{"OFF":"Take no action.","MONITOR":"Record matching clipboard activity without intervening.","WARN":"Show the user a warning banner.","BLOCK":"Prevent the clipboard operation."},"example":"WARN"},"operation":{"type":"string","enum":["COPY","PASTE"],"description":"Which clipboard operation the rule applies to.","example":"COPY"},"contentCapture":{"type":"boolean","description":"Whether the matching clipboard content is captured on the resulting events.","example":true},"maskPii":{"type":"boolean","description":"Whether personally identifiable information is masked in captured content. Required when contentCapture is true, and ignored when it is false.","example":true},"title":{"type":"string","maxLength":75,"description":"Heading of the banner shown to the user. Required when mode is WARN or BLOCK, and must be omitted for MONITOR and OFF.","example":"Sensitive content"},"subtext":{"type":"string","maxLength":1000,"description":"Message of the banner shown to the user. Markdown is supported. Required when mode is WARN or BLOCK, and must be omitted for MONITOR and OFF.","example":"Copying incident tickets outside company applications is not permitted."},"copyRedactedButtonText":{"type":"string","maxLength":75,"description":"Text of the banner button that copies a redacted version of the content. Required when mode is WARN or BLOCK and the rule matches regex patterns, and must be omitted when it does not.","example":"Copy redacted"},"copyOriginalButtonText":{"type":"string","maxLength":75,"description":"Text of the banner button that proceeds with the original content. Required when mode is WARN, and must be omitted for every other mode.","example":"Copy anyway"},"acknowledgeButtonText":{"type":"string","maxLength":75,"description":"Text of the banner button that dismisses the banner. Required when mode is BLOCK and the rule matches no regex patterns, and must be omitted otherwise.","example":"Understood"},"criteria":{"title":"Clipboard Blocking Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions. At least one of urlPatterns or regexPatterns is required.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"urlPatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match by the URL of the page the clipboard operation happens on. Each value must be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed URL pattern."},"children":[]}]}]}],"example":{"matches":["*://*.example.com/"]}},"regexPatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":"Match the clipboard content against regex patterns, referenced by enum. Each value must resolve to a pattern in the Push catalogue or in globals.customContentPatterns.","example":{"matches":["JWT","CUSTOM_INCIDENT_TICKET"]}},"profileScope":{"title":"Profile Scope","type":"object","description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"]},"minItems":1,"maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single value: ALL (any logged in profile), COMPANY_DOMAIN (profiles for your company domains), or NON_COMPANY_DOMAIN (profiles outside your company domains)."},"children":[]}]}]}],"example":["COMPANY_DOMAIN"]}},"required":["matches"]}}}},"required":["name","enabled","mode","operation","contentCapture","criteria"]}}},"required":["globals","rules"]}},"components/schemas/ClonedLoginPageDetectionConfig":{"id":"components/schemas/ClonedLoginPageDetectionConfig","kind":"json-schema","title":"Cloned Login Page Detection Configuration","data":{"title":"Cloned Login Page Detection Configuration","type":"object","description":"Complete set of Cloned Login Page Detection configuration.","properties":{"globals":{"title":"Cloned Login Page Detection Globals","type":"object","description":"Control-wide settings that apply across every rule.","properties":{"ignoredHosts":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosts ignored by cloned login page detection. Can be a domain (example.com), wildcard (*.example.com), hostname (myhost), or IP address (10.0.1.1)."},"children":[]}]}]}],"items":{"type":"string"},"example":["*.internal.example.com","build-server","10.0.1.1"]}}},"rules":{"type":"array","description":"Complete list of Cloned Login Page Detection rules.","items":{"title":"Cloned Login Page Detection Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn Finance on cloned login pages"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["MONITOR","BLOCK","WARN","OFF"],"description":"What happens when a cloned login page is detected.","x-enumDescriptions":{"MONITOR":"Detect and record, but take no action against the user.","BLOCK":"Block access to the cloned login page and show the message set by title and subtext.","WARN":"Warn the user with the message set by title and subtext, and let them proceed via the button set by ignoreButtonText.","OFF":"Take no action."},"example":"WARN"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required when mode is BLOCK or WARN, and must be omitted when mode is MONITOR or OFF.","example":"Suspicious login page"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required when mode is BLOCK or WARN, and must be omitted when mode is MONITOR or OFF.","example":"This page looks like a cloned login page. Do not enter your credentials."},"ignoreButtonText":{"type":"string","maxLength":75,"description":"Label for the button that lets the user proceed anyway. Required when mode is WARN, and must be omitted for all other modes.","example":"Proceed anyway"},"criteria":{"title":"Cloned Login Page Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}}}}},"required":["name","enabled","mode"]}}},"required":["globals","rules"]}},"components/schemas/CustomDetectionSummary":{"id":"components/schemas/CustomDetectionSummary","kind":"json-schema","title":"Custom Detection Summary","data":{"title":"Custom Detection Summary","type":"object","description":"One entry in the index of your custom detections: just enough to identify each one. Fetch a single custom detection to see its detection logic and rules.","properties":{"detectionEventType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's unique identifier. Always an uppercase identifier beginning with CUSTOM_."},"children":[]}]}]}],"example":"CUSTOM_TORRENT_WEBSITE_VISIT"},"detectionEventName":{"type":"string","description":"The custom detection's name, set when the detection was created. It cannot be updated.","example":"Torrent website visit"}},"required":["detectionEventType","detectionEventName"]}},"components/schemas/CustomDetectionPostRule":{"id":"components/schemas/CustomDetectionPostRule","kind":"json-schema","title":"New Custom Detection Control Rule","data":{"title":"New Custom Detection Control Rule","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A control rule for a new custom detection. The same shape as a stored control rule, except it carries no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": rule ids are assigned by the platform and returned in the response."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn Finance about torrent sites"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["MONITOR","WARN","BLOCK","OFF"],"description":"What happens when the rule matches.","x-enumDescriptions":{"MONITOR":"Record the detection without alerting the user. Requires severity.","WARN":"Warn the user and let them proceed. Requires severity, title, subtext and buttonText.","BLOCK":"Block the activity and show a message. Requires severity, title and subtext.","OFF":"Take no action."},"example":"WARN"},"severity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"],"description":"The severity of a detection this rule produces. Required for every mode except OFF.","example":"MEDIUM"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required for modes WARN and BLOCK.","example":"Torrent sites are not allowed"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required for modes WARN and BLOCK.","example":"Downloading torrents on company devices is not permitted."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the message's action button. Required for mode WARN.","example":"I understand"},"detectOnInternalHosts":{"type":"boolean","default":false,"description":"Rule enabled on internal hosts."},"criteria":{"title":"Custom Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}}}}},"required":["name","enabled","mode"]}},"components/schemas/CustomDetectionPost":{"id":"components/schemas/CustomDetectionPost","kind":"json-schema","title":"New Custom Detection","data":{"title":"New Custom Detection","type":"object","description":"The complete state of a new custom detection: its name, its detection logic and the control rules it starts with.","properties":{"detectionEventName":{"type":"string","maxLength":75,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's name. May only contain letters, numbers, spaces and underscores. The detection event type identifying the detection is derived from it (uppercased, spaces become underscores, prefixed with CUSTOM_) and returned in the response."},"children":[]}]}]}],"example":"Torrent website visit"},"detectionLogic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The detection logic: one or more detection rules, each a YAML document describing what the browser extension matches on, separated by the standard YAML document separator. It is stored exactly as sent. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/resources/custom-detections/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom detection specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the format of the YAML."},"children":[]}]}]}],"example":"input: web_request\nmetadata:\n  indicator: TORRENT_MAGNET_LINK_DETECTED\nconditions:\n  request_url:\n    scheme: magnet\n"},"rules":{"type":"array","minItems":1,"maxItems":50,"description":"The control rules the custom detection starts with, in priority order. At least one is required.","items":{"$ref":"#/components/schemas/CustomDetectionPostRule"}}},"required":["detectionEventName","detectionLogic","rules"]}},"components/schemas/CustomDetectionRule":{"id":"components/schemas/CustomDetectionRule","kind":"json-schema","title":"Custom Detection Control Rule","data":{"title":"Custom Detection Control Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn Finance about torrent sites"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["MONITOR","WARN","BLOCK","OFF"],"description":"What happens when the rule matches.","x-enumDescriptions":{"MONITOR":"Record the detection without alerting the user. Requires severity.","WARN":"Warn the user and let them proceed. Requires severity, title, subtext and buttonText.","BLOCK":"Block the activity and show a message. Requires severity, title and subtext.","OFF":"Take no action."},"example":"WARN"},"severity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"],"description":"The severity of a detection this rule produces. Required for every mode except OFF.","example":"MEDIUM"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required for modes WARN and BLOCK.","example":"Torrent sites are not allowed"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required for modes WARN and BLOCK.","example":"Downloading torrents on company devices is not permitted."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the message's action button. Required for mode WARN.","example":"I understand"},"detectOnInternalHosts":{"type":"boolean","default":false,"description":"Rule enabled on internal hosts."},"criteria":{"title":"Custom Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}}}}},"required":["name","enabled","mode"]}},"components/schemas/CustomDetection":{"id":"components/schemas/CustomDetection","kind":"json-schema","title":"Custom Detection","data":{"title":"Custom Detection","type":"object","description":"A single custom detection in full: its identity, its detection logic and its rules.","properties":{"detectionEventType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The custom detection's unique identifier. Always an uppercase identifier beginning with CUSTOM_."},"children":[]}]}]}],"example":"CUSTOM_TORRENT_WEBSITE_VISIT"},"detectionEventName":{"type":"string","description":"The custom detection's name, set when the detection was created. It cannot be updated.","example":"Torrent website visit"},"detectionLogic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The detection logic: one or more detection rules, each a YAML document describing what the browser extension matches on, separated by the standard YAML document separator. It is returned exactly as stored. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/resources/custom-detections/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom detection specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the format of the YAML."},"children":[]}]}]}],"example":"input: web_request\nmetadata:\n  indicator: TORRENT_MAGNET_LINK_DETECTED\nconditions:\n  request_url:\n    scheme: magnet\n"},"rules":{"type":"array","description":"The custom detection's control rules, in priority order. The first rule that matches wins.","items":{"$ref":"#/components/schemas/CustomDetectionRule"}}},"required":["detectionEventType","detectionEventName","detectionLogic","rules"]}},"components/schemas/CustomDetectionPut":{"id":"components/schemas/CustomDetectionPut","kind":"json-schema","title":"Custom Detection Desired State","data":{"title":"Custom Detection Desired State","type":"object","description":"The complete desired state of one custom detection: its detection logic and every control rule it should have.","properties":{"detectionEventType":{"type":"string","description":"Optional. The custom detection's unique identifier cannot be updated, so when present this must equal the detection event type in the URL.","example":"CUSTOM_TORRENT_WEBSITE_VISIT"},"detectionEventName":{"type":"string","description":"Optional. The custom detection's name cannot be updated, so this field is ignored: the stored name is kept and returned in the response. It is accepted so that a GET response body can be sent back unchanged.","example":"Torrent website visit"},"detectionLogic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The detection logic: one or more detection rules, each a YAML document describing what the browser extension matches on, separated by the standard YAML document separator. It is stored exactly as sent. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/resources/custom-detections/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom detection specification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the format of the YAML."},"children":[]}]}]}],"example":"input: web_request\nmetadata:\n  indicator: TORRENT_MAGNET_LINK_DETECTED\nconditions:\n  request_url:\n    scheme: magnet\n"},"rules":{"type":"array","maxItems":50,"description":"The complete list of control rules the custom detection should have, in priority order. May be empty.","items":{"$ref":"#/components/schemas/CustomDetectionRule"}}},"required":["detectionLogic","rules"]}},"components/schemas/FileDownloadBlockingConfig":{"id":"components/schemas/FileDownloadBlockingConfig","kind":"json-schema","title":"File Download Blocking Configuration","data":{"title":"File Download Blocking Configuration","type":"object","description":"Complete set of File Download Blocking configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of File Download Blocking rules.","items":{"title":"File Download Blocking Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Block executable downloads for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","MONITOR","WARN","BLOCK"],"description":"What happens when a rule matches a file download.","x-enumDescriptions":{"OFF":"Take no action.","MONITOR":"Record matching downloads without interrupting the user.","WARN":"Warn the user and let them continue. Requires title, subtext, and buttonText.","BLOCK":"Block the download and show the message set by title and subtext. Requires title and subtext."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required when mode is WARN or BLOCK.","example":"Download blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required when mode is WARN or BLOCK.","example":"This file type is not permitted on company devices."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the button that lets the user continue. Required when mode is WARN, and must not be set for any other mode.","example":"Download anyway"},"criteria":{"title":"File Download Blocking Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"fileNames":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match downloads by exact file name.","example":{"matches":["secret.txt"]}},"fileNamePatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":"Match downloads whose file name matches a regular expression.","example":{"matches":[".*\\.pdf"]}},"fileExtensions":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match downloads by file extension. Each value must begin with a dot, such as .exe or .zip.","example":{"matches":[".exe",".zip"]}},"urlPatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match downloads by the URL they came from. Each value must be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed URL pattern."},"children":[]}]}]}],"example":{"matches":["*://*.example.com/"]}},"profileScope":{"title":"Profile Scope","type":"object","description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"]},"minItems":1,"maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single value: ALL (any logged in profile), COMPANY_DOMAIN (profiles for your company domains), or NON_COMPANY_DOMAIN (profiles outside your company domains)."},"children":[]}]}]}],"example":["COMPANY_DOMAIN"]}},"required":["matches"]}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/FileUploadBlockingConfig":{"id":"components/schemas/FileUploadBlockingConfig","kind":"json-schema","title":"File Upload Blocking Configuration","data":{"title":"File Upload Blocking Configuration","type":"object","description":"Complete set of File Upload Blocking configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of File Upload Blocking rules.","items":{"title":"File Upload Blocking Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Block executable uploads for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","MONITOR","WARN","BLOCK"],"description":"What happens to the file uploads a rule matches.","x-enumDescriptions":{"OFF":"Take no action.","MONITOR":"Record matching uploads without interrupting the user.","WARN":"Warn the user with the message set by title and subtext, and let them continue via the button set by buttonText.","BLOCK":"Block the matching uploads and show the message set by title and subtext."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user when an upload is warned or blocked. Required when mode is WARN or BLOCK.","example":"Upload blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user when an upload is warned or blocked. Markdown is supported. Required when mode is WARN or BLOCK.","example":"Uploading this file type is not permitted."},"buttonText":{"type":"string","maxLength":75,"description":"Label of the button that lets the user continue past a warning. Required when mode is WARN; not permitted otherwise.","example":"Proceed anyway"},"criteria":{"title":"File Upload Blocking Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"fileNamePatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":"Match uploads by file name, using regular expressions.","example":{"matches":[".*\\.exe$"]}},"fileExtensions":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match uploads by file extension, each beginning with a dot.","example":{"matches":[".exe",".zip"]}},"urlPatterns":{"allOf":[{"$ref":"#/components/schemas/ControlConfigIncludeCondition"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Match uploads by the URL they are sent to, using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*://"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-prefixed URL patterns."},"children":[]}]}]}],"example":{"matches":["*://example.com/*"]}},"profileScope":{"title":"Profile Scope","type":"object","description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"]},"minItems":1,"maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single value: ALL (any logged in profile), COMPANY_DOMAIN (profiles for your company domains), or NON_COMPANY_DOMAIN (profiles outside your company domains)."},"children":[]}]}]}],"example":["COMPANY_DOMAIN"]}},"required":["matches"]}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/MaliciousBrowserExtensionDetectionConfig":{"id":"components/schemas/MaliciousBrowserExtensionDetectionConfig","kind":"json-schema","title":"Malicious Browser Extension Detection Configuration","data":{"title":"Malicious Browser Extension Detection Configuration","type":"object","description":"Complete set of Malicious Browser Extension Detection configuration.","properties":{"globals":{"title":"Malicious Browser Extension Detection Globals","type":"object","description":"Control-wide settings that apply across every rule.","properties":{"excludedExtensions":{"type":"array","maxItems":100,"description":"Extensions excluded from malicious browser extension detection.","items":{"title":"Excluded Extension","type":"object","properties":{"extensionId":{"type":"string","description":"The extension to exclude, identified by its extension ID, such as a 32-character Chrome extension ID.","example":"abcdefghijklmnopabcdefghijklmnop"},"notes":{"type":"string","description":"Optional free-text notes explaining why the extension is excluded.","example":"Approved by IT for the Finance team."}},"required":["extensionId"]},"example":[{"extensionId":"abcdefghijklmnopabcdefghijklmnop","notes":"Approved by IT for the Finance team."}]}}},"rules":{"type":"array","description":"Complete list of Malicious Browser Extension Detection rules.","items":{"title":"Malicious Browser Extension Detection Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Block high-severity extensions for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","MONITOR","BLOCK"],"description":"What happens to the browser extensions a rule matches.","x-enumDescriptions":{"OFF":"Take no action.","MONITOR":"Detect matching extensions without blocking them.","BLOCK":"Block the matching extensions and show the message set by title and subtext."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user when an extension is blocked. Required when mode is BLOCK, and must be omitted for MONITOR and OFF.","example":"Extension blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user when an extension is blocked. Markdown is supported. Required when mode is BLOCK, and must be omitted for MONITOR and OFF.","example":"This extension is not permitted on company devices."},"profileScope":{"title":"Profile Scope","type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"],"description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","x-enumDescriptions":{"ALL":"Any logged in profile","COMPANY_DOMAIN":"Profiles for your company domains","NON_COMPANY_DOMAIN":"Profiles outside your company domains"},"example":"COMPANY_DOMAIN"},"criteria":{"title":"Malicious Browser Extension Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"browserExtensionSeverities":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match extensions by the severity of the detection. One of LOW, MEDIUM, or HIGH.","example":{"matches":["HIGH","MEDIUM"]}}}}},"required":["name","enabled","mode"]}}},"required":["globals","rules"]}},"components/schemas/MaliciousCopyPasteDetectionConfig":{"id":"components/schemas/MaliciousCopyPasteDetectionConfig","kind":"json-schema","title":"Malicious Copy Paste Detection Configuration","data":{"title":"Malicious Copy Paste Detection Configuration","type":"object","description":"Complete set of Malicious Copy Paste Detection configuration.","properties":{"globals":{"title":"Malicious Copy Paste Detection Globals","type":"object","description":"Control-wide settings that apply across every rule.","properties":{"ignoredHosts":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosts ignored by malicious copy paste detection. Can be a domain (example.com), wildcard (*.example.com), hostname (myhost), or IP address (10.0.1.1)."},"children":[]}]}]}],"items":{"type":"string"},"example":["*.internal.example.com","build-server","10.0.1.1"]}}},"rules":{"type":"array","description":"Complete list of Malicious Copy Paste Detection rules.","items":{"title":"Malicious Copy Paste Detection Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Block malicious paste for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["MONITOR","BLOCK","WARN","OFF"],"description":"What happens when malicious copy paste activity a rule matches is detected.","x-enumDescriptions":{"MONITOR":"Detect and record matching activity without interrupting the user.","BLOCK":"Block the matching activity and show the message set by title and subtext.","WARN":"Warn the user about the matching activity, letting them proceed via the button set by buttonText.","OFF":"Take no action."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required when mode is BLOCK or WARN, and must be omitted when mode is MONITOR or OFF.","example":"Paste blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required when mode is BLOCK or WARN, and must be omitted when mode is MONITOR or OFF.","example":"This paste looks malicious and has been blocked."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the button that lets the user proceed. Required when mode is WARN, and must be omitted for every other mode.","example":"Proceed anyway"},"safeText":{"type":"string","maxLength":200,"description":"Message shown to the user when the paste is deemed safe. Required when mode is BLOCK or WARN, and must be omitted when mode is MONITOR or OFF.","example":"This paste is safe to use."},"payloadCollection":{"type":"boolean","default":false,"description":"Whether to collect the paste payload for matching activity. Applies to MONITOR, WARN, and BLOCK modes.","example":true},"osTarget":{"type":"string","enum":["WINDOWS","UNIX"],"default":"WINDOWS","description":"The operating system family this rule targets.","example":"WINDOWS"},"criteria":{"title":"Malicious Copy Paste Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}}}}},"required":["name","enabled","mode"]}}},"required":["globals","rules"]}},"components/schemas/MfaEnforcementConfig":{"id":"components/schemas/MfaEnforcementConfig","kind":"json-schema","title":"MFA Enforcement Configuration","data":{"title":"MFA Enforcement Configuration","type":"object","description":"Complete set of MFA Enforcement configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of MFA Enforcement rules.","items":{"title":"MFA Enforcement Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Require MFA acknowledgement for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["ACKNOWLEDGE","OFF"],"description":"What happens to the accounts a rule matches.","x-enumDescriptions":{"ACKNOWLEDGE":"Prompt matching users to acknowledge that MFA should be enabled, showing the message set by title, subtext, and buttonText.","OFF":"Take no action."},"example":"ACKNOWLEDGE"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user in the acknowledgement prompt. Required when mode is ACKNOWLEDGE.","example":"Enable MFA"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user in the acknowledgement prompt. Markdown is supported. Required when mode is ACKNOWLEDGE.","example":"Your account is missing MFA. Please enable it to continue."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the acknowledgement button shown to the user. Required when mode is ACKNOWLEDGE.","example":"I understand"},"criteria":{"title":"MFA Enforcement Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"appTypes":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match accounts by the app they belong to.","example":{"matches":["OKTA"]}},"appLabels":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match accounts by the labels applied to their app.","example":{"matches":["Sanctioned"]}},"appCategories":{"allOf":[{"$ref":"#/components/schemas/AppCategoriesCondition"}],"description":"Match accounts by the category of the app they belong to, given as an app category ID.","example":{"matches":["9"]}},"approvalStatuses":{"allOf":[{"$ref":"#/components/schemas/ApprovalStatusesCondition"}],"description":"Match accounts by the approval status of their app.","example":{"matches":["APPROVED"]}},"sensitivityLevels":{"allOf":[{"$ref":"#/components/schemas/SensitivityLevelsCondition"}],"description":"Match accounts by the sensitivity level of their app.","example":{"matches":["HIGH"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/PasswordLoggingPreventionConfig":{"id":"components/schemas/PasswordLoggingPreventionConfig","kind":"json-schema","title":"Password Logging Prevention Configuration","data":{"title":"Password Logging Prevention Configuration","type":"object","description":"Complete set of Password Logging Prevention configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of Password Logging Prevention rules.","items":{"title":"Password Logging Prevention Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Prevent password logging for Finance"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","MONITOR","BLOCK"],"description":"What happens when a matching person enters their password on a matching app.","x-enumDescriptions":{"OFF":"Take no action.","MONITOR":"Detect and report password entry, but take no blocking action.","BLOCK":"Block password entry and show the message set by title and subtext."},"example":"BLOCK"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user when password entry is blocked. Required when mode is BLOCK, and must be omitted otherwise.","example":"Password entry blocked"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user when password entry is blocked. Markdown is supported. Required when mode is BLOCK, and must be omitted otherwise.","example":"Entering your password on this app is not permitted."},"criteria":{"title":"Password Logging Prevention Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"appTypes":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match apps by their type.","example":{"matches":["OKTA"]}},"appLabels":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match apps by the labels applied to them.","example":{"matches":["Sanctioned"]}},"appCategories":{"allOf":[{"$ref":"#/components/schemas/AppCategoriesCondition"}],"description":"Match apps by their category.","example":{"matches":["9"]}},"approvalStatuses":{"allOf":[{"$ref":"#/components/schemas/ApprovalStatusesCondition"}],"description":"Match apps by their approval status.","example":{"matches":["APPROVED"]}},"sensitivityLevels":{"allOf":[{"$ref":"#/components/schemas/SensitivityLevelsCondition"}],"description":"Match apps by their sensitivity level.","example":{"matches":["HIGH"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/PhishingToolDetectionConfig":{"id":"components/schemas/PhishingToolDetectionConfig","kind":"json-schema","title":"Phishing Tool Detection Configuration","data":{"title":"Phishing Tool Detection Configuration","type":"object","description":"Complete set of Phishing Tool Detection configuration.","properties":{"globals":{"title":"Phishing Tool Detection Globals","type":"object","description":"Control-wide settings that apply across every rule.","properties":{"ignoredHosts":{"type":"array","maxItems":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hosts ignored by phishing tool detection. Can be a domain (example.com), wildcard (*.example.com), hostname (myhost), or IP address (10.0.1.1)."},"children":[]}]}]}],"items":{"type":"string"},"example":["*.internal.example.com","build-server","10.0.1.1"]}}},"rules":{"type":"array","description":"Complete list of Phishing Tool Detection rules.","items":{"title":"Phishing Tool Detection Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Warn Finance about phishing tools"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["MONITOR","BLOCK","WARN","OFF"],"description":"What happens when a phishing tool is detected for a matching person.","x-enumDescriptions":{"MONITOR":"Detect phishing tools silently, without showing the user a message.","BLOCK":"Block access and show the message set by title and subtext.","WARN":"Warn the user with the message set by title and subtext, letting them continue via the button labelled by ignoreButtonText.","OFF":"Take no action."},"example":"WARN"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required when mode is BLOCK or WARN, and must be omitted for MONITOR and OFF.","example":"Potential phishing tool detected"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required when mode is BLOCK or WARN, and must be omitted for MONITOR and OFF.","example":"This page looks like a phishing tool. Proceed only if you trust it."},"ignoreButtonText":{"type":"string","maxLength":75,"description":"Label for the button that lets the user continue. Required when mode is WARN, and must be omitted for MONITOR, BLOCK, and OFF.","example":"Proceed anyway"},"criteria":{"title":"Phishing Tool Detection Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}}}}},"required":["name","enabled","mode"]}}},"required":["globals","rules"]}},"components/schemas/StolenCredential":{"id":"components/schemas/StolenCredential","kind":"json-schema","title":"Stolen Credential","data":{"title":"Stolen Credential","type":"object","description":"This object represents a stolen credential.","properties":{"email":{"type":"string","description":"Email address of employee.","example":"john.hill@example.com"},"password":{"type":"string","description":"Plain text password. Note that uploading hashes will never match and only plain text passwords can be used.","example":"myAm@z!ngP4$$w0rdTh4tUcantGu3$$"},"metadata":{"title":"Metadata","type":"object","nullable":true,"description":"Metadata provided from the TI provider about where these credentials were found. This will be attached to any Stolen Credentials finding that matched with these credentials"}}}},"components/schemas/StrongPasswordEnforcementConfig":{"id":"components/schemas/StrongPasswordEnforcementConfig","kind":"json-schema","title":"Strong Password Enforcement Configuration","data":{"title":"Strong Password Enforcement Configuration","type":"object","description":"Complete set of Strong Password Enforcement configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of Strong Password Enforcement rules.","items":{"title":"Strong Password Enforcement Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Prompt Finance on weak passwords"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","ACKNOWLEDGE"],"description":"What happens when a rule matches a password finding.","x-enumDescriptions":{"OFF":"Take no action.","ACKNOWLEDGE":"Prompt the user to acknowledge the finding, showing the message set by title, subtext and buttonText."},"example":"ACKNOWLEDGE"},"title":{"type":"string","maxLength":75,"description":"Heading shown to the user. Required for every mode except OFF.","example":"Strengthen your password"},"subtext":{"type":"string","maxLength":1000,"description":"Message shown to the user. Markdown is supported. Required for every mode except OFF.","example":"This password does not meet our security policy."},"buttonText":{"type":"string","maxLength":75,"description":"Label for the acknowledgement button. Required for every mode except OFF.","example":"I understand"},"applicableFindings":{"type":"array","description":"Which password findings the rule applies to. Required (and must be non-empty) for every mode except OFF.","items":{"type":"string","enum":["WEAK_PASSWORD","LEAKED_PASSWORD","STOLEN_CREDENTIALS","REUSED_PASSWORD"]},"example":["WEAK_PASSWORD","REUSED_PASSWORD"]},"criteria":{"title":"Strong Password Enforcement Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"appTypes":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match the apps the password is used on.","example":{"matches":["OKTA"]}},"appLabels":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match apps by the labels applied to them.","example":{"matches":["Critical"]}},"appCategories":{"allOf":[{"$ref":"#/components/schemas/AppCategoriesCondition"}],"description":"Match apps by their category.","example":{"matches":["9"]}},"approvalStatuses":{"allOf":[{"$ref":"#/components/schemas/ApprovalStatusesCondition"}],"description":"Match apps by their approval status.","example":{"matches":["APPROVED"]}},"sensitivityLevels":{"allOf":[{"$ref":"#/components/schemas/SensitivityLevelsCondition"}],"description":"Match apps by their assigned sensitivity level.","example":{"matches":["HIGH"]}}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/FileDownloadTelemetryConfig":{"id":"components/schemas/FileDownloadTelemetryConfig","kind":"json-schema","title":"File Download Telemetry Configuration","data":{"title":"File Download Telemetry Configuration","type":"object","description":"Complete set of File Download Telemetry configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of File Download Telemetry rules.","items":{"title":"File Download Telemetry Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Collect download telemetry for Engineering"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","ON"],"description":"Whether to collect file download telemetry when the rule matches.","x-enumDescriptions":{"OFF":"Do not collect telemetry.","ON":"Collect telemetry."},"example":"ON"},"criteria":{"title":"File Download Telemetry Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"profileScope":{"title":"Profile Scope","type":"object","description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"]},"minItems":1,"maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single value: ALL (any logged in profile), COMPANY_DOMAIN (profiles for your company domains), or NON_COMPANY_DOMAIN (profiles outside your company domains)."},"children":[]}]}]}],"example":["COMPANY_DOMAIN"]}},"required":["matches"]}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/FileUploadTelemetryConfig":{"id":"components/schemas/FileUploadTelemetryConfig","kind":"json-schema","title":"File Upload Telemetry Configuration","data":{"title":"File Upload Telemetry Configuration","type":"object","description":"Complete set of File Upload Telemetry configuration.","properties":{"globals":{"type":"object","description":"Reserved for control-wide settings. Empty for this control.","example":{}},"rules":{"type":"array","description":"Complete list of File Upload Telemetry rules.","items":{"title":"File Upload Telemetry Rule","type":"object","properties":{"id":{"type":"string","description":"The rule's unique identifier.","example":"c478966c-f927-411c-b919-179832d3d50c"},"name":{"type":"string","description":"A short name to help you recognise the rule.","example":"Collect upload telemetry for Engineering"},"enabled":{"type":"boolean","description":"Whether the rule is active.","example":true},"mode":{"type":"string","enum":["OFF","ON"],"description":"Whether to collect file upload telemetry when the rule matches.","x-enumDescriptions":{"OFF":"Do not collect telemetry.","ON":"Collect telemetry."},"example":"ON"},"criteria":{"title":"File Upload Telemetry Criteria","type":"object","description":"Restrict the rule to apply only under the specified conditions, and where telemetry is collected from.","properties":{"employeeIds":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match specific employees by their employee identifier.","example":{"matches":["8c4f1d2e-9a0b-4c1d-8e2f-3a4b5c6d7e8f"]}},"employeeGroups":{"allOf":[{"$ref":"#/components/schemas/ControlConfigCondition"}],"description":"Match employees by the groups they belong to.","example":{"matches":["Finance","Engineering"]}},"profileScope":{"title":"Profile Scope","type":"object","description":"Match by the profile in use on the browser. If omitted, defaults to ALL.","properties":{"matches":{"type":"array","items":{"type":"string","enum":["ALL","COMPANY_DOMAIN","NON_COMPANY_DOMAIN"]},"minItems":1,"maxItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single value: ALL (any logged in profile), COMPANY_DOMAIN (profiles for your company domains), or NON_COMPANY_DOMAIN (profiles outside your company domains)."},"children":[]}]}]}],"example":["COMPANY_DOMAIN"]}},"required":["matches"]}}}},"required":["name","enabled","mode"]}}},"required":["rules"]}},"components/schemas/FindingType":{"id":"components/schemas/FindingType","kind":"json-schema","title":"FindingType","data":{"title":"FindingType","type":"string","enum":["MFA_NOT_REGISTERED","REUSED_PASSWORD","SHARED_ACCOUNT","UNUSED_THIRD_PARTY_APP","WEAK_PASSWORD","LEAKED_PASSWORD","PASSWORD_MANAGER_NOT_USED","STOLEN_CREDENTIALS"],"x-enumDescriptions":{"MFA_NOT_REGISTERED":"This account does not have MFA.","REUSED_PASSWORD":"The password used on the account is being reused.","SHARED_ACCOUNT":"The account credentials are being shared with another employee.","UNUSED_THIRD_PARTY_APP":"Deprecated; no longer in use but still accepted for compatibility.","WEAK_PASSWORD":"The password used on the account is weak.","LEAKED_PASSWORD":"The password used on the account has been leaked in a data breach.","PASSWORD_MANAGER_NOT_USED":"The employee typically uses manually typed passwords, rather than a password manager.","STOLEN_CREDENTIALS":"The credentials used on the account have been identified as stolen."},"description":"The type of finding"}},"components/schemas/FindingState":{"id":"components/schemas/FindingState","kind":"json-schema","title":"FindingState","data":{"type":"string","enum":["OPEN","RESOLVED"],"x-enumDescriptions":{"OPEN":"The finding has been confirmed and is open.","RESOLVED":"The finding has been resolved and is no longer an issue."},"description":"The state of the finding"}},"components/schemas/WeakPasswordReasonsType":{"id":"components/schemas/WeakPasswordReasonsType","kind":"json-schema","title":"WeakPasswordReasonsType","data":{"type":"string","enum":["COMMON_BASE_WORD","BANNED_BASE_WORD"],"x-enumDescriptions":{"COMMON_BASE_WORD":"The base word is a derivative of top 10000 most used passwords.","BANNED_BASE_WORD":"The password is a derivative of a custom banned word."},"description":"Reason a password is weak"}},"components/schemas/Finding":{"id":"components/schemas/Finding","kind":"json-schema","title":"Finding","data":{"title":"Finding","type":"object","description":"This object represents a finding in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the finding","example":"d6a32ba5-0532-4a66-8137-48cdf409c972"},"type":{"$ref":"#/components/schemas/FindingType"},"state":{"$ref":"#/components/schemas/FindingState"},"employeeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the employee this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an employee."},"children":[]}]}]}],"example":"379ac7ea-ff2a-42ef-af37-06d2020dc46a","nullable":true},"passwordId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the password this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to a password."},"children":[]}]}]}],"example":"c4a045a1-5331-4714-af83-6a361e98960d","nullable":true},"accountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the account this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an account."},"children":[]}]}]}],"nullable":true},"appType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of app this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an app."},"children":[]}]}]}],"example":"PUSH_SECURITY","nullable":true},"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the app this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an app."},"children":[]}]}]}],"example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0","nullable":true},"weakPasswordReasons":{"type":"array","items":{"$ref":"#/components/schemas/WeakPasswordReasonsType"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reasons a password is weak, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not a WEAK_PASSWORD finding."},"children":[]}]}]}],"nullable":true},"creationTimestamp":{"type":"integer","description":"When this finding was first observed, formatted as a UNIX timestamp (in seconds)","example":1698064423}}}},"components/schemas/FindingDetail":{"id":"components/schemas/FindingDetail","kind":"json-schema","title":"FindingDetail","data":{"title":"FindingDetail","type":"object","description":"This object represents a finding in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the finding","example":"d6a32ba5-0532-4a66-8137-48cdf409c972"},"type":{"$ref":"#/components/schemas/FindingType"},"state":{"$ref":"#/components/schemas/FindingState"},"employeeId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the employee this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an employee."},"children":[]}]}]}],"example":"379ac7ea-ff2a-42ef-af37-06d2020dc46a","nullable":true},"passwordId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the password this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to a password."},"children":[]}]}]}],"example":"c4a045a1-5331-4714-af83-6a361e98960d","nullable":true},"accountId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the account this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an account."},"children":[]}]}]}],"nullable":true},"appType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of app this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an app."},"children":[]}]}]}],"example":"PUSH_SECURITY","nullable":true},"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the app this finding is linked to, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if finding is not linked to an app."},"children":[]}]}]}],"example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0","nullable":true},"weakPasswordReasons":{"type":"array","items":{"$ref":"#/components/schemas/WeakPasswordReasonsType"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reasons a password is weak, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not a WEAK_PASSWORD finding."},"children":[]}]}]}],"nullable":true},"creationTimestamp":{"type":"integer","description":"When this finding was first observed, formatted as a UNIX timestamp (in seconds)","example":1698064423}}}},"components/schemas/AccountOther":{"id":"components/schemas/AccountOther","kind":"json-schema","title":"Account (other)","data":{"title":"Account (other)","type":"object","description":"This object represents an account (other) in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for the account","example":"1009e8cb-497b-49ae-ac87-e083e42078d2"},"employeeId":{"type":"string","description":"Identifier of primary employee that this account belongs to","example":"72d0347a-2663-4ef5-b1c5-df39163f1603"},"otherAppId":{"type":"string","description":"The ID of the app associated with this account","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"email":{"type":"string","description":"The email address used to log into the account","format":"email","example":"john.hill@example.com"},"loginMethods":{"type":"object","required":["passwordLogin","oidcLogin","samlLogin","fedCmLogin"],"properties":{"passwordLogin":{"type":"boolean","description":"Whether or not this account has been logged into with a password","example":true},"oidcLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do an OIDC login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no OIDC login has been performed."},"children":[]}]}]}],"nullable":true,"example":"GOOGLE_WORKSPACE"},"samlLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do a SAML login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no SAML login has been performed."},"children":[]}]}]}],"nullable":true,"example":"OKTA"},"fedCmLogin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identity provider that was used to do a FedCM login on this account. This is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no FedCM login has been performed."},"children":[]}]}]}],"nullable":true,"example":"GOOGLE_WORKSPACE"}}},"creationTimestamp":{"type":"integer","description":"When the account was first observed, formatted as a UNIX timestamp (in seconds)","example":1698064423},"lastUsedTimestamp":{"type":"integer","nullable":true,"description":"When the account was last used by an employee, formatted as a UNIX timestamp (in seconds)","example":1698669168}}}},"components/schemas/AppOther":{"id":"components/schemas/AppOther","kind":"json-schema","title":"App (Other)","data":{"title":"App (Other)","type":"object","description":"This object represents an app (other) in your organization.","properties":{"id":{"type":"string","description":"Unique identifier for this object","example":"35603905-ff98-4b7d-8940-eb1906a2bdf6"},"domain":{"type":"string","description":"Domain the user logged into. This value is null if a OIDC login is used","example":"app.pushsecurity.com","nullable":true},"oauthAppId":{"type":"string","description":"ID of the oauth app from the Identity Provider. This value is null if a password login is used.","example":"1234567890","nullable":true},"name":{"type":"string","description":"Name of the app. This value is null if a password login is used.","example":"Push Security","nullable":true},"hidden":{"type":"boolean","description":"Whether the app is hidden or not."},"requestSupportStatus":{"type":"string","description":"Current request support status of the app","example":"DISCOVERED"},"creationTimestamp":{"type":"integer","description":"When the app was first observed, formatted as a UNIX timestamp (in seconds)","example":1698064423}}}},"components/schemas/SeverityType":{"id":"components/schemas/SeverityType","kind":"json-schema","title":"SeverityType","data":{"title":"SeverityType","enum":["LOW","MEDIUM","HIGH","CRITICAL"],"description":"The severity of the detection"}},"components/schemas/DetectionType":{"id":"components/schemas/DetectionType","kind":"json-schema","title":"DetectionType","data":{"title":"DetectionType","description":"The type of detection","example":"PHISHING","enum":["BLOCKED_URL","CUSTOM","PHISHING","MALICIOUS_BROWSER_EXTENSION","MALWARE_DELIVERY","STOLEN_CREDENTIALS"]}},"components/schemas/ResponseTypeDetection":{"id":"components/schemas/ResponseTypeDetection","kind":"json-schema","title":"ResponseType","data":{"title":"ResponseType","enum":["BLOCKED","EMPLOYEE_IGNORED_WARNING","EMPLOYEE_WARNED","NOT_BLOCKED"],"description":"The response for the detection"}},"components/schemas/ClassificationType":{"id":"components/schemas/ClassificationType","kind":"json-schema","title":"ClassificationType","data":{"title":"ClassificationType","nullable":false,"type":"string","enum":["NOT_SET","TRUE_POSITIVE","BENIGN_TRUE_POSITIVE","FALSE_POSITIVE"],"description":"The classification for the detection"}},"components/schemas/DetectionWithEmployee":{"id":"components/schemas/DetectionWithEmployee","kind":"json-schema","title":"Detection","data":{"title":"Detection","type":"object","description":"This object represents a detection event, indicating an employee has triggered an alert.","properties":{"id":{"type":"string","description":"Identifier of the detection","example":"c478966c-f927-411c-b919-179832d3d50c"},"employeeId":{"type":"string","description":"Identifier for the employee that triggered the detection.","example":"37cda962-7e78-49bc-8721-1becd16276a3"},"employee":{"$ref":"#/components/schemas/EmployeeInEvent"},"browserId":{"type":"string","description":"Identifier of the browser that was used when the detection was triggered.","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"severity":{"type":"string","description":"The severity of the detection.","example":"HIGH","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"detectionType":{"type":"string","description":"The type of detection.","example":"PHISHING","enum":["PHISHING","BLOCKED_URL","STOLEN_CREDENTIALS","MALICIOUS_BROWSER_EXTENSION","MALWARE_DELIVERY"]},"response":{"type":"string","description":"The response to the detection.","example":"BLOCKED","enum":["BLOCKED","EMPLOYEE_IGNORED_WARNING","EMPLOYEE_WARNED","NOT_BLOCKED"]},"creationTimestamp":{"type":"integer","description":"When the detection was created. Formatted as a UNIX timestamp (in seconds).","example":1698604061},"archived":{"type":"boolean","description":"Whether the detection has been archived.","example":true}}}},"components/schemas/DetectionEventType":{"id":"components/schemas/DetectionEventType","kind":"json-schema","title":"DetectionEventType","data":{"title":"DetectionEventType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of detection event. Built-in detection types use a fixed set of values. Custom detection types follow the pattern "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PHISHING_TOOL_DETECTED","oneOf":[{"title":"Built-in detections","type":"string","description":"Built-in detection event types.","enum":["PHISHING_TOOL_DETECTED","CLONED_LOGIN_PAGE_DETECTED","SSO_PASSWORD_USED","PROTECTED_PASSWORD_ENTERED","STOLEN_CREDENTIALS","BLOCKED_URL_VISITED","BLOCKED_DOMAIN_VISITED","MALICIOUS_COPY_PASTE_DETECTED","KNOWN_BAD_BROWSER_EXTENSION_DETECTED","THREAT_DETECTED","AGENTIC_HUNT_DISCOVERED_THREAT"]},{"title":"Custom detections","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom detection event types. Always starts with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM_"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"pattern":"^CUSTOM_","example":"CUSTOM_TORRENT_WEBSITE_VISIT"}]}},"components/schemas/ControlModeType":{"id":"components/schemas/ControlModeType","kind":"json-schema","title":"ControlModeType","data":{"title":"ControlModeType","type":"string","nullable":true,"enum":["INFORM","ACKNOWLEDGE","REASON","BLOCK","WARN","MONITOR"],"description":"All possible ENUM values for control modes."}},"components/schemas/ResponseTypeDetectionEvent":{"id":"components/schemas/ResponseTypeDetectionEvent","kind":"json-schema","title":"ResponseType","data":{"title":"ResponseType","enum":["BLOCKED","EMPLOYEE_IGNORED_WARNING","EMPLOYEE_WARNED","NOT_BLOCKED"],"description":"The response for the detection event."}},"components/schemas/DetectionChildEvent":{"id":"components/schemas/DetectionChildEvent","kind":"json-schema","title":"DetectionChildEvent","data":{"title":"DetectionChildEvent","type":"object","description":"This object represents an event that is associated with a detection.","properties":{"id":{"type":"string","description":"Identifier of the detection event.","example":"c478966c-f927-411c-b919-179832d3d50c"},"creationTimestamp":{"type":"integer","description":"When the event was created. Formatted as a UNIX timestamp (in seconds).","example":1698604061},"detectionEventType":{"$ref":"#/components/schemas/DetectionEventType"},"detectionEventName":{"oneOf":[{"title":"Built-in detections","type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not available for built-in detection event types. Will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"title":"Custom detections","type":"string","description":"The name of the custom detection event.","example":"Torrent website visit"}]},"accountId":{"type":"string","description":"Identifier of the account that the detection event is associated with.","example":"37cda962-7e78-49bc-8721-1becd16276a3","nullable":true},"appType":{"type":"string","description":"The type of app that the detection event is associated with.","example":"PUSH_SECURITY","nullable":true},"phishingToolIndicator":{"type":"string","example":"AITM_TOOL_EVILGINX_01","nullable":true},"controlMode":{"$ref":"#/components/schemas/ControlModeType","nullable":true},"description":{"type":"string","description":"The description of the detection event. Note: this is subject to change and should not be used to match on this object.","example":"Phishing attempt detected","nullable":true},"clonedLoginPageIndicator":{"type":"string","example":"MICROSOFT_01","nullable":true},"extensionId":{"type":"string","description":"The identifier of the browser extension involved in the detection event.","example":"dljjddkmmcminffjbcmeccgfbjlhmhlm","nullable":true},"extensionName":{"type":"string","description":"The name of the browser extension involved in the detection event.","example":"Example Extension","nullable":true},"profileEmail":{"type":"string","description":"The email associated with the browser profile involved in the detection event.","example":"john.hill@example.com","nullable":true},"maliciousBrowserExtensionIndicator":{"type":"string","example":"EXTENSION_ID","nullable":true},"customIndicator":{"type":"string","example":"TORRENT_MAGNET_LINK"},"response":{"$ref":"#/components/schemas/ResponseTypeDetectionEvent"},"email":{"type":"string","description":"The email associated with the account related to the detection event.","example":"john.hill@example.com","nullable":true},"url":{"type":"string","description":"The URL that the detection event was triggered on.","example":"https://example.com/phishing","nullable":true},"referrerUrl":{"type":"string","description":"The referrer URL.","example":"https://mail.google.com","nullable":true},"clonedLoginPageUrls":{"type":"array","items":{"type":"string"},"description":"The legitimate login page URL that was cloned.","example":["https://example.com/phishing"],"nullable":true},"sourceIpAddress":{"type":"string","description":"The source IP address.","example":"8.158.25.38"},"metadata":{"type":"string","description":"The metadata associated with the detection event.","example":"{\"source_type\": \"Telegram\", \"breach_type\": \"Stealer Malware Logs\", \"breach_publication_date\": \"2025-04-01\"}"},"experimental":{"type":"boolean","description":"Indicates if this detection event is experimental.","example":false},"domainCategories":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","description":"Category code.","example":39},"name":{"type":"string","description":"Friendly category name.","example":"Gambling"}}},"description":"The domain categories that were matched when a blocked domain was visited.","nullable":true}}}},"components/schemas/DetectionTimelineEvent":{"id":"components/schemas/DetectionTimelineEvent","kind":"json-schema","title":"DetectionTimelineEvent","data":{"title":"DetectionTimelineEvent","type":"object","description":"This object represents a single event in the timeline of browser activity that led to a detection.","properties":{"traceOrder":{"type":"integer","description":"The position of this event in the timeline. Higher values are more recent. Values are ordered but not necessarily contiguous.","example":42},"eventTimestamp":{"type":"integer","description":"When the event occurred in the browser. Formatted as a UNIX timestamp (in seconds).","example":1698604061},"kind":{"type":"string","description":"The kind of browser activity. Note: new kinds are added over time and should be handled gracefully.","enum":["CLICK","CLIPBOARD_CONTENT_REPLACED","CLIPBOARD_CONTENT_RETURNED","DETECTION","ENTERED_PASSWORD","ENTER_KEY_PRESS","FILE_DOWNLOAD","FORM_SUBMIT","NAVIGATION","PASSWORD_ENTERED","REDIRECT","TAB_CLOSED","TAB_OPENED","WINDOW_POPUP"],"x-enumDescriptions":{"CLICK":"The page was clicked.","CLIPBOARD_CONTENT_REPLACED":"The clipboard content was replaced with safe text.","CLIPBOARD_CONTENT_RETURNED":"The original content was returned to the clipboard.","DETECTION":"The detection was triggered.","ENTERED_PASSWORD":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated. See PASSWORD_ENTERED."},"children":[]}]}]}],"ENTER_KEY_PRESS":"The enter key was pressed.","FILE_DOWNLOAD":"A file was downloaded.","FORM_SUBMIT":"A form was submitted.","NAVIGATION":"The browser navigated to a URL.","PASSWORD_ENTERED":"A password was entered.","REDIRECT":"The browser was redirected to another URL.","TAB_CLOSED":"A browser tab was closed.","TAB_OPENED":"A browser tab was opened.","WINDOW_POPUP":"A popup window was opened."},"example":"TAB_OPENED"},"detectionEventType":{"$ref":"#/components/schemas/DetectionEventType","nullable":true},"url":{"type":"string","description":"The URL associated with the event.","example":"https://example.com/phishing","nullable":true},"domain":{"type":"string","description":"The domain extracted from the URL.","example":"example.com","nullable":true},"domainCategories":{"type":"array","items":{"type":"object","properties":{"code":{"type":"integer","description":"Category code.","example":39},"name":{"type":"string","description":"Friendly category name.","example":"Gambling"}}},"description":"The domain categories that were matched when a blocked domain was visited.","nullable":true},"appType":{"type":"string","description":"The type of app associated with the event.","example":"PUSH_SECURITY","nullable":true},"indicator":{"type":"string","description":"For DETECTION events, the indicator that triggered the detection. Note: new indicators are added over time and should be handled gracefully.","example":"MICROSOFT_01","nullable":true},"response":{"$ref":"#/components/schemas/ResponseTypeDetectionEvent","nullable":true}}}},"components/schemas/DetectionId":{"id":"components/schemas/DetectionId","kind":"json-schema","title":"Detection","data":{"title":"Detection","type":"object","description":"This object represents a detection event, indicating an employee has triggered an alert.","properties":{"id":{"type":"string","description":"Identifier of the detection","example":"c478966c-f927-411c-b919-179832d3d50c"},"employeeId":{"type":"string","description":"Identifier for the employee that triggered the detection.","example":"37cda962-7e78-49bc-8721-1becd16276a3"},"employee":{"$ref":"#/components/schemas/EmployeeInEvent"},"browserId":{"type":"string","description":"Identifier of the browser that was used when the detection was triggered.","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"severity":{"$ref":"#/components/schemas/SeverityType"},"detectionType":{"$ref":"#/components/schemas/DetectionType"},"response":{"$ref":"#/components/schemas/ResponseTypeDetection"},"creationTimestamp":{"type":"integer","description":"When the detection was created. Formatted as a UNIX timestamp (in seconds).","example":1698604061},"archived":{"type":"boolean","description":"Whether the detection has been archived.","example":true},"classification":{"type":"string","description":"The classification of the detection.","nullable":true,"example":"FALSE_POSITIVE","enum":["TRUE_POSITIVE","BENIGN_TRUE_POSITIVE","FALSE_POSITIVE"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/DetectionChildEvent"},"description":"The events associated with the detection."},"timelineEvents":{"type":"array","items":{"$ref":"#/components/schemas/DetectionTimelineEvent"},"description":"The timeline of browser activity that led to the detection. Only the most recent 1,000 events are returned."}}}},"components/schemas/Detection":{"id":"components/schemas/Detection","kind":"json-schema","title":"Detection","data":{"title":"Detection","type":"object","description":"This object represents a detection event, indicating an employee has triggered an alert.","properties":{"id":{"type":"string","description":"Identifier of the detection","example":"c478966c-f927-411c-b919-179832d3d50c"},"employeeId":{"type":"string","description":"Identifier for the employee that triggered the detection.","example":"37cda962-7e78-49bc-8721-1becd16276a3"},"browserId":{"type":"string","description":"Identifier of the browser that was used when the detection was triggered.","example":"2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"},"severity":{"type":"string","description":"The severity of the detection.","example":"HIGH","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"detectionType":{"$ref":"#/components/schemas/DetectionType"},"response":{"type":"string","description":"The response to the detection.","example":"BLOCKED","enum":["BLOCKED","EMPLOYEE_IGNORED_WARNING","EMPLOYEE_WARNED","NOT_BLOCKED"]},"classification":{"type":"string","description":"The classification of the detection.","nullable":true,"example":"FALSE_POSITIVE","enum":["TRUE_POSITIVE","BENIGN_TRUE_POSITIVE","FALSE_POSITIVE"]},"creationTimestamp":{"type":"integer","description":"When the detection was created. Formatted as a UNIX timestamp (in seconds).","example":1698604061},"archived":{"type":"boolean","description":"Whether the detection has been archived.","example":true}}}},"schema_439":{"kind":"json-schema","data":{"type":"string"},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":500,"default":500},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"object","properties":{"loginMethod":{"type":"string","enum":["USERNAME_PASSWORD","OKTA_SWA","OIDC","SAML","FEDCM"],"description":"The login method to remove from the account.","example":"OIDC"}},"required":["loginMethod"]},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountUser"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AccountOther"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/App"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"object","properties":{"approvalStatus":{"type":"string","enum":["APPROVED","NOT_APPROVED","UNDER_REVIEW"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The desired approval status for the app. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current approval status will be unset."},"children":[]}]}]}],"example":"APPROVED","nullable":true},"sensitivityLevel":{"type":"string","enum":["HIGH","MEDIUM","LOW"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The desired sensitivity level for the app. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current sensitivity level will be unset."},"children":[]}]}]}],"example":"HIGH","nullable":true},"notes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The desired notes for the app. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", any existing notes will be deleted."},"children":[]}]}]}],"example":"Last security audit: 16 January 2024","nullable":true},"ownerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The employee ID for the owner of this app. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current owner will be unset."},"children":[]}]}]}],"nullable":true}}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string","description":"The label to add to the app (max 50 characters)","example":"personal-use"}},"required":["label"]},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"string"},"description":"The labels associated with the app.","example":["personal-use","other-label"]}},"required":["labels"]},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"object","properties":{"label":{"type":"string","description":"The label to delete from the app.","example":"personal-use"}},"required":["label"]},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"labels":{"type":"array","items":{"type":"string"},"description":"The labels associated with the app.","example":["other-label"]}},"required":["labels"]},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/AppOther"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BrowserType"},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OSType"},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Browser"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DeploymentMode"},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/BrowserExtension"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SeverityType"},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DetectionType"},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ResponseTypeDetection"},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"$ref":"#/components/schemas/ClassificationType"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/DetectionWithEmployee"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"object","properties":{"archived":{"type":"boolean","description":"The desired archive status for the detection.","example":true},"classification":{"type":"string","nullable":true,"enum":["TRUE_POSITIVE","BENIGN_TRUE_POSITIVE","FALSE_POSITIVE"],"description":"The desired classification for the detection.","example":"FALSE_POSITIVE"}}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"default":1000},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInList"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the employee.","example":"John"},"lastName":{"type":"string","description":"The last name of the employee.","example":"Doe"},"email":{"type":"string","description":"The email address of the employee.","example":"john.doe@example.com"},"enrolBrowser":{"type":"boolean","description":"Whether the employee will be sent an email to ask them to install the Push browser extension.","example":true}},"required":["firstName","lastName","email","enrolBrowser"]},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","description":"A new primary email address for the employee. This must be one of the known email addresses for the employee.","format":"email"},"firstName":{"type":"string","description":"A new first name for the employee"},"lastName":{"type":"string","description":"A new last name for the employee"},"chatopsEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set whether the employee has ChatOps enabled"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"blockquote","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version."},"children":[]}]}]}]}],"deprecated":true},"licensed":{"type":"boolean","description":"Set whether the employee is licensed on the Push platform"},"groups":{"type":"array","maxItems":300,"description":"Set the groups an employee is in (this will overwrite the existing groups)","items":{"type":"string","maxLength":100}}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/Employee","type":"string","nullable":true,"description":"Returned when unlicensing an employee"}]},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Enrollment URL that can be used to link a browser extension to this employee","example":"https://console.pushsecurity.com/setup/browser?step=INSTALL&token=e194ec91-6961-454b-acf3-1a8f4e1fc606"}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"object","properties":{"group":{"type":"string","maxLength":100,"description":"The name of the group.","example":"Engineering team"}},"required":["group"]},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"},"description":"The groups associated with the employee.","example":["Engineering team","Marketing team"]}},"required":["groups"]},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"object","properties":{"group":{"type":"string","description":"The group to remove employee from.","example":"Engineering team"}},"required":["group"]},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"string"},"description":"The groups associated with the employee.","example":["Other team"]}},"required":["groups"]},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"object","properties":{"secondaryEmployeeIds":{"type":"array","items":{"type":"string"},"minItems":1,"maxItems":5,"description":"A list of employee IDs.","example":["72d0347a-2663-4ef5-b1c5-df39163f1603","87569da6-fb7a-4df7-8ce2-246c14044911"]}},"required":["secondaryEmployeeIds"]},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"object","properties":{"email":{"type":"string","description":"The email address to unmerge from the target employee","example":"john.hill@example.com"}},"required":["email"]},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"paging":{"type":"object","properties":{"moreResults":{"type":"boolean","description":"Whether there are more results available","example":true},"next":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request"},"children":[]}]}]}],"example":"501","nullable":true,"deprecated":true},"nextToken":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the next page that can be used as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the next request."},"children":[]}]}]}],"example":"0b9972aa-fe8d-4095-82d3-2e13cf3cfd43","nullable":true}}}}},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","description":"Your organization's custom detections.","items":{"$ref":"#/components/schemas/CustomDetectionSummary"}}}},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"type":"string","pattern":"^CUSTOM_[A-Z0-9_]+$"},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/StolenCredential"},"minItems":1,"maxItems":500,"example":[{"email":"john.hill@example.com","password":"myAm@z!ngP4$$w0rdTh4tUcantGu3$$","metadata":{"key":"value"}}]},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/StolenCredential"},"minItems":1,"maxItems":500}}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"type":"string","$ref":"#/components/schemas/BlockedURL"},"example":["*://*.example.com/*","*://other.example.com/path/to*"]}}},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ControlsBlockedUrlsHostPath"},{"$ref":"#/components/schemas/ControlsBlockedUrlsUrl"}]},"id":"schema_485"}},"exampleStore":{"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup":{"value":{"globals":{},"rules":[{"name":"Warn Finance about risky apps","enabled":true,"mode":"ACKNOWLEDGE","title":"Approved apps only","subtext":"Please only use apps approved by IT.","buttonText":"I understand","displayFrequency":"ONCE_PER_BROWSER","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"acknowledgeForGroup","summary":"Show an acknowledgement banner to the Finance group","id":"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"},"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason":{"value":{"globals":{},"rules":[{"name":"Block gaming apps","enabled":true,"mode":"BLOCK","title":"This app is blocked","subtext":"Contact IT if you need access.","allowReasonSubmission":true,"buttonText":"Request access","criteria":{"appCategories":{"matches":["25"]}}}]},"key":"blockWithReason","summary":"Block and let the user submit a reason","id":"paths/~1v1~1controls~1appBanner~1configuration/put/requestBody/content/application~1json/examples/blockWithReason"},"paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl":{"value":{"globals":{},"rules":[{"name":"Warn on internal admin portal","enabled":true,"mode":"INFORM","title":"Handle with care","subtext":"This is an internal admin tool. Do not paste customer data.","criteria":{"urlPatterns":{"matches":["*://*.example.com/"]}}}]},"key":"informForUrl","summary":"Show an informational banner on matching URLs","id":"paths/~1v1~1controls~1appBannerUrlPattern~1configuration/put/requestBody/content/application~1json/examples/informForUrl"},"paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{},"rules":[{"name":"Block risky extensions for Finance","enabled":true,"mode":"BLOCK","title":"Extension blocked","subtext":"This extension is not permitted on company devices.","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"blockForGroup","summary":"Block matching extensions for the Finance group","id":"paths/~1v1~1controls~1browserExtensionBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{"customContentPatterns":[]},"rules":[]},"key":"removeAllRules","summary":"Remove all rules and clear custom content patterns","id":"paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets":{"value":{"globals":{"customContentPatterns":[{"name":"Incident ticket","regex":"INC-\\d{6}"}]},"rules":[{"name":"Warn when copying incident tickets","enabled":true,"mode":"WARN","operation":"COPY","contentCapture":false,"title":"Sensitive content","subtext":"Copying incident tickets outside company applications is not permitted.","copyOriginalButtonText":"Copy anyway","copyRedactedButtonText":"Copy redacted","criteria":{"regexPatterns":{"matches":["CUSTOM_INCIDENT_TICKET"]},"profileScope":{"matches":["COMPANY_DOMAIN"]}}}]},"key":"warnOnIncidentTickets","summary":"Warn when incident tickets are copied on company profiles","id":"paths/~1v1~1controls~1clipboardBlocking~1configuration/put/requestBody/content/application~1json/examples/warnOnIncidentTickets"},"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup":{"value":{"globals":{"ignoredHosts":["*.internal.example.com","build-server"]},"rules":[{"name":"Warn Finance on cloned login pages","enabled":true,"mode":"WARN","title":"Suspicious login page","subtext":"This page looks like a cloned login page. Do not enter your credentials.","ignoreButtonText":"Proceed anyway","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"warnForGroup","summary":"Warn the Finance group on cloned login pages","id":"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"},"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone":{"value":{"globals":{},"rules":[{"name":"Block cloned login pages","enabled":true,"mode":"BLOCK","title":"Access blocked","subtext":"This page has been blocked because it appears to be a cloned login page.","criteria":{}}]},"key":"blockForEveryone","summary":"Block cloned login pages for everyone","id":"paths/~1v1~1controls~1clonedLoginPageDetection~1configuration/put/requestBody/content/application~1json/examples/blockForEveryone"},"paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone":{"value":{"detectionLogic":"input: web_request\nmetadata:\n  indicator: TORRENT_MAGNET_LINK_DETECTED\nconditions:\n  request_url:\n    scheme: magnet\n","rules":[{"name":"Monitor everyone","enabled":true,"mode":"MONITOR","severity":"LOW"}]},"key":"monitorEveryone","summary":"Monitor everyone","id":"paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/monitorEveryone"},"paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules":{"value":{"detectionLogic":"input: web_request\nmetadata:\n  indicator: TORRENT_MAGNET_LINK_DETECTED\nconditions:\n  request_url:\n    scheme: magnet\n","rules":[]},"key":"noRules","summary":"Keep the detection logic but remove all rules","id":"paths/~1v1~1controls~1customDetections~1{detectionEventType}/put/requestBody/content/application~1json/examples/noRules"},"paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{},"rules":[{"name":"Block executable downloads for Finance","enabled":true,"mode":"BLOCK","title":"Download blocked","subtext":"This file type is not permitted on company devices.","criteria":{"employeeGroups":{"matches":["Finance"]},"fileExtensions":{"matches":[".exe"]},"profileScope":{"matches":["COMPANY_DOMAIN"]}}}]},"key":"blockForGroup","summary":"Block executable downloads for the Finance group on company domains","id":"paths/~1v1~1controls~1fileDownloadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{},"rules":[{"name":"Block executable uploads for Finance","enabled":true,"mode":"BLOCK","title":"Upload blocked","subtext":"Uploading this file type is not permitted.","criteria":{"employeeGroups":{"matches":["Finance"]},"fileExtensions":{"matches":[".exe",".zip"]},"profileScope":{"matches":["COMPANY_DOMAIN"]}}}]},"key":"blockForGroup","summary":"Block executable uploads for the Finance group on company domains","id":"paths/~1v1~1controls~1fileUploadBlocking~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup":{"value":{"globals":{},"rules":[{"name":"Require MFA acknowledgement for Finance","enabled":true,"mode":"ACKNOWLEDGE","title":"Enable MFA","subtext":"Your account is missing MFA. Please enable it to continue.","buttonText":"I understand","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"acknowledgeForGroup","summary":"Require an MFA acknowledgement for the Finance group","id":"paths/~1v1~1controls~1mfaEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"},"paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{"excludedExtensions":[]},"rules":[]},"key":"removeAllRules","summary":"Remove all rules and clear excluded extensions","id":"paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{"excludedExtensions":[{"extensionId":"abcdefghijklmnopabcdefghijklmnop","notes":"Approved by IT for the Finance team."}]},"rules":[{"name":"Block high-severity extensions for Finance","enabled":true,"mode":"BLOCK","title":"Extension blocked","subtext":"This extension is not permitted on company devices.","criteria":{"employeeGroups":{"matches":["Finance"]},"browserExtensionSeverities":{"matches":["HIGH"]}}}]},"key":"blockForGroup","summary":"Block high-severity extensions for the Finance group","id":"paths/~1v1~1controls~1maliciousBrowserExtensionDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{"ignoredHosts":["*.internal.example.com","build-server"]},"rules":[{"name":"Block malicious paste for Finance","enabled":true,"mode":"BLOCK","title":"Paste blocked","subtext":"This paste looks malicious and has been blocked.","safeText":"This paste is safe to use.","payloadCollection":true,"osTarget":"WINDOWS","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"blockForGroup","summary":"Block malicious pastes for the Finance group","id":"paths/~1v1~1controls~1maliciousCopyPasteDetection~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup":{"value":{"globals":{},"rules":[{"name":"Prevent password logging for Finance","enabled":true,"mode":"BLOCK","title":"Password entry blocked","subtext":"Entering your password on this app is not permitted.","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"blockForGroup","summary":"Prevent password logging for the Finance group","id":"paths/~1v1~1controls~1passwordLoggingPrevention~1configuration/put/requestBody/content/application~1json/examples/blockForGroup"},"paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup":{"value":{"globals":{"ignoredHosts":["*.internal.example.com","build-server"]},"rules":[{"name":"Warn Finance about phishing tools","enabled":true,"mode":"WARN","title":"Potential phishing tool detected","subtext":"This page looks like a phishing tool. Proceed only if you trust it.","ignoreButtonText":"Proceed anyway","criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"warnForGroup","summary":"Warn the Finance group about phishing tools","id":"paths/~1v1~1controls~1phishingToolDetection~1configuration/put/requestBody/content/application~1json/examples/warnForGroup"},"paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup":{"value":{"globals":{},"rules":[{"name":"Prompt Finance on weak passwords","enabled":true,"mode":"ACKNOWLEDGE","title":"Strengthen your password","subtext":"This password does not meet our security policy.","buttonText":"I understand","applicableFindings":["WEAK_PASSWORD","REUSED_PASSWORD"],"criteria":{"employeeGroups":{"matches":["Finance"]}}}]},"key":"acknowledgeForGroup","summary":"Prompt the Finance group to acknowledge weak passwords","id":"paths/~1v1~1controls~1strongPasswordEnforcement~1configuration/put/requestBody/content/application~1json/examples/acknowledgeForGroup"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost":{"value":{"host":"domain.com"},"key":"allPathsForHost","summary":"Block all paths for the given host using the default path wildcard.","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForHost"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain":{"value":{"host":"sub.domain.com"},"key":"allPathsForSubdomain","summary":"Block all paths for the given subdomain using the default path wildcard.","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/allPathsForSubdomain"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards":{"value":{"host":"*.sub.domain.com","path":"path/*/something/*"},"key":"wildcards","summary":"Wildcards used both in the host and path.","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/wildcards"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain":{"value":{"url":"domain.com"},"key":"fullUrlSpecificDomain","summary":"Block all URLs on a specific domain","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSpecificDomain"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain":{"value":{"url":"*.domain.com"},"key":"fullUrlSubdomain","summary":"Block all URLs on any subdomain of a specific domain","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlSubdomain"},"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern":{"value":{"url":"*.sub.domain.com/path/*/something/*"},"key":"fullUrlPathPattern","summary":"Block paths matching the pattern on any subdomain of a specific domain","id":"paths/~1v1~1controls~1blockedUrls/post/requestBody/content/application~1json/examples/fullUrlPathPattern"},"paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup":{"value":{"globals":{},"rules":[{"name":"Collect download telemetry for Engineering","enabled":true,"mode":"ON","criteria":{"employeeGroups":{"matches":["Engineering"]},"profileScope":{"matches":["COMPANY_DOMAIN"]}}}]},"key":"collectForGroup","summary":"Collect telemetry for the Engineering group on company domains","id":"paths/~1v1~1telemetry~1fileDownload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"},"paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules":{"value":{"globals":{},"rules":[]},"key":"removeAllRules","summary":"Remove all rules","id":"paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/removeAllRules"},"paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup":{"value":{"globals":{},"rules":[{"name":"Collect upload telemetry for Engineering","enabled":true,"mode":"ON","criteria":{"employeeGroups":{"matches":["Engineering"]},"profileScope":{"matches":["COMPANY_DOMAIN"]}}}]},"key":"collectForGroup","summary":"Collect telemetry for the Engineering group on company domains","id":"paths/~1v1~1telemetry~1fileUpload~1configuration/put/requestBody/content/application~1json/examples/collectForGroup"}},"securitySchemeStore":{"x-api-key":{"id":"x-api-key","type":"apiKey","description":"API key authentication","in":"header","paramName":"x-api-key"}},"servers":[{"url":"https://api.pushsecurity.com"}]},"options":{"codeSamples":{"languages":[{"lang":"curl"},{"lang":"Python"},{"lang":"Node.js"}],"skipOptionalParameters":true},"jsonSamplesExpandLevel":5,"onlyRequiredInSamples":true,"sortRequiredPropsFirst":true,"schemasExpansionLevel":"all","layout":"three-panel","hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/help/audience/engineering/_bundle/rest-v1.json?download"},{"url":"/help/audience/engineering/_bundle/rest-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Push Security REST API","description":"## Overview\n\nThe Push Security REST API provides programmatic access to the administrative functionality of the Push platform. This API adheres to RESTful principles, featuring resource-oriented URLs that are predictable and easy to navigate.\n\nThe API uses JSON-formatted request bodies and responses along with standard HTTP response codes, authentication methods, and HTTP verbs.\n\n[Rate limits](#section/Rate-limits) are in place to ensure consistent performance for all users.\n\n## Authentication\n\nTo interact with the Push Security API, you'll need an API key for authentication. To create or manage your API keys, go to the [Settings](https://console.pushsecurity.com/app/settings/api-keys) page in the Push admin console.\n\nWhen generating a new key, you have two permission levels to choose from: `Read only` and `Full access`. A `Read only` key lets you make GET requests, while `Full access` allows for all types of requests.\n\nTo authenticate your API requests, include a header named `x-api-key` and set its value to your API key.\n\nAll API calls must be made over HTTPS.\n\n## Rate limits\n\nThe Push Security API enforces rate limiting to ensure equitable access and maintain performance. Each user is permitted up to 10 API requests per second, with a temporary burst capacity that allows an additional 10 requests for brief intervals.\n\nIf you surpass these limits, the API will return a 429 status code as an indication.\n\n## Response size\n\nResponses are limited to 1MB. A request to a list endpoint that would return more than 1MB of data is rejected with a 422 status code and the status `RESULT_SIZE_EXCEEDED`. Lower the `limit` parameter and make the request again.\n\n## Errors\n\nThe Push Security API uses standard HTTP response codes to signal the outcome of an API call. Here's what you need to know:\n\n2xx codes: These indicate that your request was successful.\n\n4xx codes: A client-side issue, usually because something is missing or incorrect in your request.\n\n5xx codes: These suggest a problem on our end, although these occurrences are infrequent.\n\n### Common Response Codes\n\n| HTTP Code | Description                                             |\n|-----------|---------------------------------------------------------|\n| 200 OK    | Your request was successfully processed.                 |\n| 400 Bad Request | Your request is missing something or is incorrect. Double-check your parameters.  |\n| 422 Unprocessable Content | The requested page of results is larger than the 1MB response size limit. Lower the `limit` parameter.  |\n| 429 Too Many Requests | You've exceeded the rate limits. Consider implementing exponential backoffs in your API calls.  |\n| 500 Server Error | Something's not right on our end.                      |\n\n## Versioning\n\nYou're currently working with version 1 of the Push Security API. Should there be any breaking changes in the future, we'll bump up the API version number. If you hold an active API key, we'll send you notifications over email about the deprecation date for the older version."}},"baseSlug":"/rest-v1","routesMapping":{}}