Download OpenAPI specification:Download
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.
The API uses JSON-formatted request bodies and responses along with standard HTTP response codes, authentication methods, and HTTP verbs.
Rate limits are in place to ensure consistent performance for all users.
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 Settings page in the Push admin console. You can get there by clicking Create API key from the top right corner of this documentation.
When 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.
To authenticate your API requests, include a header named x-api-key
and set its value to your API key.
All API calls must be made over HTTPS.
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.
If you surpass these limits, the API will return a 429 status code as an indication.
The Push Security API uses standard HTTP response codes to signal the outcome of an API call. Here's what you need to know:
2xx codes: These indicate that your request was successful.
4xx codes: A client-side issue, usually because something is missing or incorrect in your request.
5xx codes: These suggest a problem on our end, although these occurrences are infrequent.
HTTP Code | Description |
---|---|
200 OK | Your request was successfully processed. |
400 Bad Request | Your request is missing something or is incorrect. Double-check your parameters. |
429 Too Many Requests | You've exceeded the rate limits. Consider implementing exponential backoffs in your API calls. |
500 Server Error | Something's not right on our end. |
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.
OK
Bad Request
{- "result": [
- {
- "id": "d6a32ba5-0532-4a66-8137-48cdf409c972",
- "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
- "appType": "ATLASSIAN",
- "appId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "mfaRegistered": true,
- "mfaMethods": [
- "APP_TOTP"
], - "passwordId": "4c13674f-e88a-4411-bfa2-53a70468a898",
- "loginMethods": {
- "passwordLogin": true,
- "oidcLogin": "GOOGLE_WORKSPACE",
- "samlLogin": "OKTA",
- "oktaSwaLogin": true,
- "vendorSsoLogin": "GOOGLE_WORKSPACE"
}, - "creationTimestamp": 1698064423,
- "lastUsedTimestamp": 1698669168
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for the account Example: "d6a32ba5-0532-4a66-8137-48cdf409c972" | ||||||||||||||||||||||||||
employeeId | string Identifier of primary employee that this account belongs to Example: "72d0347a-2663-4ef5-b1c5-df39163f1603" | ||||||||||||||||||||||||||
appType | string The app associated with this account Example: "ATLASSIAN" | ||||||||||||||||||||||||||
appId | string The ID of the app associated with this account Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" | ||||||||||||||||||||||||||
string <email> The email address used to log into the account Example: "john.hill@example.com" | |||||||||||||||||||||||||||
mfaRegistered | boolean or null Whether MFA is registered or not. If unknown, Example: true | ||||||||||||||||||||||||||
mfaMethods | Array of strings or null (MfaMethodsType) The MFA methods registered for this account
| ||||||||||||||||||||||||||
passwordId | string or null 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 Example: "4c13674f-e88a-4411-bfa2-53a70468a898" | ||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
creationTimestamp | integer When this account was created, formatted as a UNIX timestamp (in seconds) Example: 1698064423 | ||||||||||||||||||||||||||
lastUsedTimestamp | integer or null When the account was last used by an employee, formatted as a UNIX timestamp (in seconds) Example: 1698669168 |
Bad Request
Account Not Found
{- "id": "d6a32ba5-0532-4a66-8137-48cdf409c972",
- "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
- "appType": "ATLASSIAN",
- "appId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "mfaRegistered": true,
- "mfaMethods": [
- "APP_TOTP"
], - "passwordId": "4c13674f-e88a-4411-bfa2-53a70468a898",
- "loginMethods": {
- "passwordLogin": true,
- "oidcLogin": "GOOGLE_WORKSPACE",
- "samlLogin": "OKTA",
- "oktaSwaLogin": true,
- "vendorSsoLogin": "GOOGLE_WORKSPACE"
}, - "creationTimestamp": 1698064423,
- "lastUsedTimestamp": 1698669168
}
OK
employeeId | string Identifier of the employee has access to this account Example: "bf4cf562-7830-41ac-80e3-d261da1c9bb9" |
lastUsedTimestamp | integer or null When the account was last used by an employee, formatted as a UNIX timestamp (in seconds) Example: 1698669223 |
passwordManuallyTyped | boolean Whether the password was manually typed (or a password manager was used) on the last login. This value is Example: true |
Bad Request
{- "employeeId": "bf4cf562-7830-41ac-80e3-d261da1c9bb9",
- "lastUsedTimestamp": 1698669223,
- "passwordManuallyTyped": true
}
OK
employeeId | string Identifier of the employee has access to this account Example: "bf4cf562-7830-41ac-80e3-d261da1c9bb9" |
lastUsedTimestamp | integer or null When the account was last used by an employee, formatted as a UNIX timestamp (in seconds) Example: 1698669223 |
passwordManuallyTyped | boolean Whether the password was manually typed (or a password manager was used) on the last login. This value is Example: true |
Bad Request
{- "employeeId": "bf4cf562-7830-41ac-80e3-d261da1c9bb9",
- "lastUsedTimestamp": 1698669223,
- "passwordManuallyTyped": true
}
These objects represent the accounts (other) (owned by employees) in your organization.
string Filter by email address. Accepts partial email addresses for wildcard searches. | |
otherAppId | string Filter by other app ID. |
lastUsedTimestampAfter | integer Filter by when the account was last used by an employee - start time. This is a UNIX timestamp (in seconds). |
lastUsedTimestampBefore | integer Filter by when the account was last used by an employee - end time. This is a UNIX timestamp (in seconds). |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects (Account (other)) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
object | |||||||||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "1009e8cb-497b-49ae-ac87-e083e42078d2",
- "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
- "otherAppId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "loginMethods": {
- "passwordLogin": true,
- "oidcLogin": "GOOGLE_WORKSPACE",
- "samlLogin": "OKTA"
}, - "creationTimestamp": 1698064423,
- "lastUsedTimestamp": 1698669168
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for the account Example: "1009e8cb-497b-49ae-ac87-e083e42078d2" | ||||||
employeeId | string Identifier of primary employee that this account belongs to Example: "72d0347a-2663-4ef5-b1c5-df39163f1603" | ||||||
otherAppId | string The ID of the app associated with this account Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" | ||||||
string <email> The email address used to log into the account Example: "john.hill@example.com" | |||||||
object | |||||||
| |||||||
creationTimestamp | integer When the account was first observed, formatted as a UNIX timestamp (in seconds) Example: 1698064423 | ||||||
lastUsedTimestamp | integer or null When the account was last used by an employee, formatted as a UNIX timestamp (in seconds) Example: 1698669168 |
Bad Request
Account (Other) Not Found
{- "id": "1009e8cb-497b-49ae-ac87-e083e42078d2",
- "employeeId": "72d0347a-2663-4ef5-b1c5-df39163f1603",
- "otherAppId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "loginMethods": {
- "passwordLogin": true,
- "oidcLogin": "GOOGLE_WORKSPACE",
- "samlLogin": "OKTA"
}, - "creationTimestamp": 1698064423,
- "lastUsedTimestamp": 1698669168
}
creationTimestampAfter | integer Filter by when the app was first observed - start time. This is a UNIX timestamp (in seconds). |
creationTimestampBefore | integer Filter by when the app was first observed - end time. This is a UNIX timestamp (in seconds). |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects (App) | |||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "type": "ZAPIER",
- "approvalStatus": "UNDER_REVIEW",
- "sensitivityLevel": "HIGH",
- "ownerId": "87569da6-fb7a-4df7-8ce2-246c14044911",
- "notes": "Last security audit: 16 January 2023",
- "description": "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": "Zapier",
- "labels": [
- "GenAI",
- "marketing"
], - "creationTimestamp": 1698064423
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for this object Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" | ||||||||
type | string The type of app, formatted as an ENUM value. Example: "ZAPIER" | ||||||||
approvalStatus | string or null (ApprovalStatusType) Approval status of the app,
| ||||||||
sensitivityLevel | string or null (SensitivityLevelType) The sensitivity level of the app,
| ||||||||
ownerId | string or null Identifier of the employee who is the owner of this platform Example: "87569da6-fb7a-4df7-8ce2-246c14044911" | ||||||||
notes | string Notes recorded on this app Example: "Last security audit: 16 January 2023" | ||||||||
website | string URL to the app's homepage Example: "https://zapier.com/" | ||||||||
description | string 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 | string The friendly name of the app Example: "Zapier" | ||||||||
labels | Array of strings Labels associated with this app Example: ["GenAI","marketing"] | ||||||||
creationTimestamp | integer When the app was first observed, formatted as a UNIX timestamp (in seconds) Example: 1698064423 |
Bad Request
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "type": "ZAPIER",
- "approvalStatus": "UNDER_REVIEW",
- "sensitivityLevel": "HIGH",
- "ownerId": "87569da6-fb7a-4df7-8ce2-246c14044911",
- "notes": "Last security audit: 16 January 2023",
- "description": "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": "Zapier",
- "labels": [
- "GenAI",
- "marketing"
], - "creationTimestamp": 1698064423
}
Update an app's approval status, sensitivity level, and/or notes.
approvalStatus | string or null The desired approval status for the app. If Example: "APPROVED" |
sensitivityLevel | string or null The desired sensitivity level for the app. If Example: "HIGH" |
notes | string or null The desired notes for the app. If Example: "Last security audit: 16 January 2024" |
OK
id | string Unique identifier for this object Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" | ||||||||
type | string The type of app, formatted as an ENUM value. Example: "ZAPIER" | ||||||||
approvalStatus | string or null (ApprovalStatusType) Approval status of the app,
| ||||||||
sensitivityLevel | string or null (SensitivityLevelType) The sensitivity level of the app,
| ||||||||
ownerId | string or null Identifier of the employee who is the owner of this platform Example: "87569da6-fb7a-4df7-8ce2-246c14044911" | ||||||||
notes | string Notes recorded on this app Example: "Last security audit: 16 January 2023" | ||||||||
website | string URL to the app's homepage Example: "https://zapier.com/" | ||||||||
description | string 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 | string The friendly name of the app Example: "Zapier" | ||||||||
labels | Array of strings Labels associated with this app Example: ["GenAI","marketing"] | ||||||||
creationTimestamp | integer When the app was first observed, formatted as a UNIX timestamp (in seconds) Example: 1698064423 |
Bad Request
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "type": "ZAPIER",
- "approvalStatus": "UNDER_REVIEW",
- "sensitivityLevel": "HIGH",
- "ownerId": "87569da6-fb7a-4df7-8ce2-246c14044911",
- "notes": "Last security audit: 16 January 2023",
- "description": "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": "Zapier",
- "labels": [
- "GenAI",
- "marketing"
], - "creationTimestamp": 1698064423
}
OK. Returns all labels still associated with the app after the label is deleted.
Invalid input
The app with the given ID is not found or the given label is not associated with the app.
{- "labels": [
- "other-label"
]
}
creationTimestampAfter | integer Filter by when the app was first observed - start time. This is a UNIX timestamp (in seconds). |
creationTimestampBefore | integer Filter by when the app was first observed - end time. This is a UNIX timestamp (in seconds). |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects (App (Other)) | |||||||||||||||
Array
| |||||||||||||||
object | |||||||||||||||
Bad Request
{- "result": [
- {
- "id": "35603905-ff98-4b7d-8940-eb1906a2bdf6",
- "domain": "app.pushsecurity.com",
- "oauthAppId": "1234567890",
- "name": "Push Security",
- "hidden": true,
- "requestSupportStatus": "DISCOVERED",
- "creationTimestamp": 1698064423
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for this object Example: "35603905-ff98-4b7d-8940-eb1906a2bdf6" |
domain | string or null Domain the user logged into. This value is null if a OIDC login is used Example: "app.pushsecurity.com" |
oauthAppId | string or null ID of the oauth app from the Identity Provider. This value is null if a password login is used. Example: "1234567890" |
name | string or null Name of the app. This value is null if a password login is used. Example: "Push Security" |
hidden | boolean Whether the app is hidden or not. |
requestSupportStatus | string Current request support status of the app Example: "DISCOVERED" |
creationTimestamp | integer When the app was first observed, formatted as a UNIX timestamp (in seconds) Example: 1698064423 |
Bad Request
App (Other) Not Found
{- "id": "35603905-ff98-4b7d-8940-eb1906a2bdf6",
- "domain": "app.pushsecurity.com",
- "oauthAppId": "1234567890",
- "name": "Push Security",
- "hidden": true,
- "requestSupportStatus": "DISCOVERED",
- "creationTimestamp": 1698064423
}
Retrieve a list of browser objects
string Filter by email address. Accepts partial email addresses for wildcard searches. | |
employeeId | string Filter by employee ID. |
browser | any (BrowserType) Filter by browser name. |
os | any (OSType) Filter by operating system name. |
lastOnlineTimestampAfter | integer Filter by when the browser was last used by an employee - start time. This is a UNIX timestamp (in seconds). |
lastOnlineTimestampBefore | integer Filter by when the browser was last used by an employee - end time. This is a UNIX timestamp (in seconds). |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects or null (Browser) | |||||||||||||||||||||||
Array
| |||||||||||||||||||||||
object | |||||||||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "1852b6ab-0cca-4c8d-8f14-4905497504ec",
- "employeeId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "version": "125.0.0.0",
- "tokenType": "INDIVIDUAL",
- "isActive": true,
- "browser": "CHROME",
- "os": "MACOS",
- "extensionVersion": "1.66.17",
- "creationTimestamp": 1698669223,
- "lastOnlineTimestamp": 1716290202
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for the browser Example: "1852b6ab-0cca-4c8d-8f14-4905497504ec" |
employeeId | string Unique identifier for the employee Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" |
string <email> Email address of the employee Example: "john.hill@example.com" | |
version | string Version of the browser Example: "125.0.0.0" |
tokenType | string Type of enrollment token used |
isActive | boolean Whether the browser extension is used by a licensed employee Example: true |
browser | any (BrowserType) The browser used by the employee |
os | any (OSType) The OS used by the employee |
extensionVersion | string Version of the Push extension Example: "1.66.17" |
creationTimestamp | integer When this browser object was created, formatted as a UNIX timestamp (in seconds) Example: 1698669223 |
lastOnlineTimestamp | integer When this browser was last seen, formatted as a UNIX timestamp (in seconds) Example: 1716290202 |
Bad Request
{- "id": "1852b6ab-0cca-4c8d-8f14-4905497504ec",
- "employeeId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "version": "125.0.0.0",
- "tokenType": "INDIVIDUAL",
- "isActive": true,
- "browser": "CHROME",
- "os": "MACOS",
- "extensionVersion": "1.66.17",
- "creationTimestamp": 1698669223,
- "lastOnlineTimestamp": 1716290202
}
chatopsEnabled | boolean Deprecated Filter by whether they have ChatOps enabled 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. |
licensed | boolean Filter by whether they are licensed on the Push platform |
groups | Array of strings Filter by groups the employee is in. |
string Filter by email address. Accepts partial email addresses for wildcard searches. | |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects (Employee) | |||||||||||||||||||||
Array
| |||||||||||||||||||||
object | |||||||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "firstName": "John",
- "lastName": "Hill",
- "department": "Security Engineering",
- "location": "New York",
- "licensed": true,
- "chatopsEnabled": true,
- "groups": [
- "engineering",
- "marketing"
], - "creationTimestamp": 1698669223
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for the employee Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" |
string <email> Email address of the employee Example: "john.hill@example.com" | |
firstName | string First name of the employee Example: "John" |
lastName | string Last name of the employee Example: "Hill" |
department | string Department - as provided by connected API integrations Example: "Security Engineering" |
location | string Location - as provided by connected API integrations Example: "New York" |
licensed | boolean Whether the employee is licensed on the Push platform Example: true |
chatopsEnabled | boolean Deprecated Whether the employee has ChatOps enabled 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. Example: true |
groups | Array of strings Groups the employee is in Example: ["engineering","marketing"] |
creationTimestamp | integer When this employee was created, formatted as a UNIX timestamp (in seconds) Example: 1698669223 |
Bad Request
Employee Not Found
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "firstName": "John",
- "lastName": "Hill",
- "department": "Security Engineering",
- "location": "New York",
- "licensed": true,
- "chatopsEnabled": true,
- "groups": [
- "engineering",
- "marketing"
], - "creationTimestamp": 1698669223
}
chatopsEnabled | boolean Deprecated Set whether the employee has ChatOps enabled 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. |
licensed | boolean Set whether the employee is licensed on the Push platform |
groups | Array of strings Set the groups an employee is in (this will overwrite the existing groups) |
OK. Returns null
if you unlicense an employee that hasn't got any accounts
id | string Unique identifier for the employee Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" |
string <email> Email address of the employee Example: "john.hill@example.com" | |
firstName | string First name of the employee Example: "John" |
lastName | string Last name of the employee Example: "Hill" |
department | string Department - as provided by connected API integrations Example: "Security Engineering" |
location | string Location - as provided by connected API integrations Example: "New York" |
licensed | boolean Whether the employee is licensed on the Push platform Example: true |
chatopsEnabled | boolean Deprecated Whether the employee has ChatOps enabled 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. Example: true |
groups | Array of strings Groups the employee is in Example: ["engineering","marketing"] |
creationTimestamp | integer When this employee was created, formatted as a UNIX timestamp (in seconds) Example: 1698669223 |
Bad Request with status EMPLOYEE_NOT_LICENSED, EXCEEDED_MAX_LICENSED_EMPLOYEES or CHATOPS_NOT_IN_WORKING_STATE
Employee Not Found
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "email": "john.hill@example.com",
- "firstName": "John",
- "lastName": "Hill",
- "department": "Security Engineering",
- "location": "New York",
- "licensed": true,
- "chatopsEnabled": true,
- "groups": [
- "engineering",
- "marketing"
], - "creationTimestamp": 1698669223
}
OK. Returns all groups still associated with the employee after being removed.
Invalid input
The employee with the given ID is not found or the employee is not a member of the given group.
{- "groups": [
- "Other team"
]
}
state | string Filter by finding state. |
type | string Filter by the type of finding. |
employeeId | string Filter by the employee associated with the finding. |
appType | string Filter by the app that is associated with the finding. |
accountId | string Filter by the account that is associated with the finding. |
passwordId | string Filter by the password identifier that is associated with the finding. |
creationTimestampAfter | string Filter by when the finding was first observed - start time. This is a UNIX timestamp (in seconds). |
creationTimestampBefore | integer Filter by when the finding was first observed - end time. This is a UNIX timestamp (in seconds). |
limit | integer [ 1 .. 50 ] Default: 50 Used for pagination. Number of objects to return. |
offset | integer Default: 0 Used for pagination. Number of objects to skip. |
OK
Array of objects (Finding) | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "d6a32ba5-0532-4a66-8137-48cdf409c972",
- "type": "MFA_NOT_REGISTERED",
- "state": "OPEN",
- "employeeId": "379ac7ea-ff2a-42ef-af37-06d2020dc46a",
- "passwordId": "c4a045a1-5331-4714-af83-6a361e98960d",
- "accountId": "string",
- "appType": "PUSH_SECURITY",
- "appId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "weakPasswordReasons": [
- "COMPROMISED_HIBP"
], - "creationTimestamp": 1698064423
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for the finding Example: "d6a32ba5-0532-4a66-8137-48cdf409c972" | ||||||||||||||||||
type | string (FindingType) The type of finding
| ||||||||||||||||||
state | string (FindingState) The state of the finding
| ||||||||||||||||||
employeeId | string or null ID of the employee this finding is linked to, Example: "379ac7ea-ff2a-42ef-af37-06d2020dc46a" | ||||||||||||||||||
passwordId | string or null ID of the password this finding is linked to, Example: "c4a045a1-5331-4714-af83-6a361e98960d" | ||||||||||||||||||
accountId | string or null ID of the account this finding is linked to, | ||||||||||||||||||
appType | string or null The type of app this finding is linked to, Example: "PUSH_SECURITY" | ||||||||||||||||||
appId | string or null ID of the app this finding is linked to, Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" | ||||||||||||||||||
weakPasswordReasons | Array of strings or null (FindingType) Reasons a password is weak,
| ||||||||||||||||||
creationTimestamp | integer When this finding was first observed, formatted as a UNIX timestamp (in seconds) Example: 1698064423 |
Bad Request
{- "id": "d6a32ba5-0532-4a66-8137-48cdf409c972",
- "type": "MFA_NOT_REGISTERED",
- "state": "OPEN",
- "employeeId": "379ac7ea-ff2a-42ef-af37-06d2020dc46a",
- "passwordId": "c4a045a1-5331-4714-af83-6a361e98960d",
- "accountId": "string",
- "appType": "PUSH_SECURITY",
- "appId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "weakPasswordReasons": [
- "COMPROMISED_HIBP"
], - "creationTimestamp": 1698064423
}
OK
Array of objects (App Banner) | |||||||||||||||||
Array
| |||||||||||||||||
object | |||||||||||||||||
Bad Request
{- "result": [
- {
- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "appType": "ZAPIER",
- "enabled": true,
- "title": "This is a title",
- "subtext": "This is the subtext that supports limited [markdown](https://markdown.org)",
- "mode": "INFORM",
- "buttonText": "Proceed anyway",
- "allowReasonSubmission": false
}
], - "paging": {
- "moreResults": true,
- "next": "51"
}
}
OK
id | string Unique identifier for this object Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" |
appType | string The type of app, formatted as an ENUM value. Example: "ZAPIER" |
enabled | boolean Whether the app banner is enabled or disabled Example: true |
title | string Title of the app banner. Example: "This is a title" |
subtext | string Subtext of the app banner. Example: "This is the subtext that supports limited [markdown](https://markdown.org)" |
mode | string (AppBannerModeType) All possible ENUM values for app banner modes |
buttonText | string or null Button text of the app banner. Only applicable when the app banner is in Example: "Proceed anyway" |
allowReasonSubmission | boolean or null Whether the user is allowed to submit a request to access a blocked page. Only applicable when the app banner is in Example: false |
Bad Request
Not Found
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "appType": "ZAPIER",
- "enabled": true,
- "title": "This is a title",
- "subtext": "This is the subtext that supports limited [markdown](https://markdown.org)",
- "mode": "INFORM",
- "buttonText": "Proceed anyway",
- "allowReasonSubmission": false
}
Set an app banner for a specific app
enabled required | boolean Set whether the app banner is enabled or disabled |
title | string Set the title of the app banner (max 75 characters) Example: "This is a title" |
subtext | string Set the subtext of the app banner (supports markdown links) (max 1000 characters) Example: "This is the subtext that supports limited [markdown](https://markdown.org)" |
mode | string (AppBannerModeType) All possible ENUM values for app banner modes |
buttonText | string Set the button text of the app banner (max 75 characters). Only applicable when the app banner is in Example: "Proceed anyway" |
allowReasonSubmission | boolean Set whether the user is allowed to submit a request to access a blocked page. Only applicable when the app banner is in |
OK. Returns the app banner details.
id | string Unique identifier for this object Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0" |
appType | string The type of app, formatted as an ENUM value. Example: "ZAPIER" |
enabled | boolean Whether the app banner is enabled or disabled Example: true |
title | string Title of the app banner. Example: "This is a title" |
subtext | string Subtext of the app banner. Example: "This is the subtext that supports limited [markdown](https://markdown.org)" |
mode | string (AppBannerModeType) All possible ENUM values for app banner modes |
buttonText | string or null Button text of the app banner. Only applicable when the app banner is in Example: "Proceed anyway" |
allowReasonSubmission | boolean or null Whether the user is allowed to submit a request to access a blocked page. Only applicable when the app banner is in Example: false |
Invalid input
App Not Found
{- "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
- "appType": "ZAPIER",
- "enabled": true,
- "title": "This is a title",
- "subtext": "This is the subtext that supports limited [markdown](https://markdown.org)",
- "mode": "INFORM",
- "buttonText": "Proceed anyway",
- "allowReasonSubmission": false
}
A URL pattern used to block access to matching sites.
host required | string 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 | string The path part of the URL pattern. Wildcards are supported. If not specified, the wildcard Example: "/path/to*" |
OK
This object represents a URL pattern used to block access to matching sites.
Bad Request
"*://*.example.com/*"