These objects represent the accounts (owned by employees) in your organization.
/
Forget an account
Push Security REST API (v1)
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.
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. |
Download OpenAPI description
Overview
URL
support
License
Languages
Servers
https://api.pushsecurity.com/
- https://api.pushsecurity.com/v1/accounts/{id}
- curl
- Python
- Node.js
curl -i -X GET \
'https://api.pushsecurity.com/v1/accounts/{id}' \
-H 'x-api-key: YOUR_API_KEY_HERE'OK
Identifier of primary employee that this account belongs to
Example: "72d0347a-2663-4ef5-b1c5-df39163f1603"
The ID of the app associated with this account
Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
Whether MFA is registered or not. If unknown, null is provided.
Example: true
The MFA methods registered for this account
| Enum Value | Description |
|---|---|
| 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 |
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 null if password authentication is not used.
Example: "4c13674f-e88a-4411-bfa2-53a70468a898"
Whether or not this account has been logged into with a password
Example: true
When the account was last logged into using a password, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
The identity provider that was used to do an OIDC login on this account. This is null if no OIDC login has been performed.
Example: "GOOGLE_WORKSPACE"
When the account was last logged into using OIDC, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
The identity provider that was used to do a SAML login on this account. This is null if no SAML login has been performed.
Example: "OKTA"
When the account was last logged into using SAML, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Whether or not this account has been logged into with Okta SWA
Example: true
When the account was last logged into using Okta SWA, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Whether or not this account has an associated vendor SSO provider.
Example: "GOOGLE_WORKSPACE"
The identity provider that was used to do a FedCM login on this account. This is null if no FedCM login has been performed.
Example: "GOOGLE_WORKSPACE"
When this account was created, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Response
application/json
{ "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, "lastPasswordLoginTimestamp": 1698064423, "oidcLogin": "GOOGLE_WORKSPACE", "lastOidcLoginTimestamp": 1698064423, "samlLogin": "OKTA", "lastSamlLoginTimestamp": 1698064423, "oktaSwaLogin": true, "lastOktaSwaLoginTimestamp": 1698064423, "vendorSsoLogin": "GOOGLE_WORKSPACE", "fedCmLogin": "GOOGLE_WORKSPACE", "lastFedCmLoginTimestamp": 1698064423 }, "creationTimestamp": 1698064423, "lastUsedTimestamp": 1698669168 }
- https://api.pushsecurity.com/v1/accounts/{id}
- curl
- Python
- Node.js
curl -i -X DELETE \
'https://api.pushsecurity.com/v1/accounts/{id}' \
-H 'x-api-key: YOUR_API_KEY_HERE'Response
application/json
{ "id": "d6a32ba5-0532-4a66-8137-48cdf409c972", "object": "ACCOUNT", "deleted": true }
- https://api.pushsecurity.com/v1/accounts/{id}/loginMethods
- curl
- Python
- Node.js
curl -i -X DELETE \
'https://api.pushsecurity.com/v1/accounts/{id}/loginMethods' \
-H 'Content-Type: application/json' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"loginMethod": "OIDC"
}'OK
Identifier of primary employee that this account belongs to
Example: "72d0347a-2663-4ef5-b1c5-df39163f1603"
The ID of the app associated with this account
Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"
Whether MFA is registered or not. If unknown, null is provided.
Example: true
The MFA methods registered for this account
| Enum Value | Description |
|---|---|
| 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 |
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 null if password authentication is not used.
Example: "4c13674f-e88a-4411-bfa2-53a70468a898"
Whether or not this account has been logged into with a password
Example: true
When the account was last logged into using a password, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
The identity provider that was used to do an OIDC login on this account. This is null if no OIDC login has been performed.
Example: "GOOGLE_WORKSPACE"
When the account was last logged into using OIDC, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
The identity provider that was used to do a SAML login on this account. This is null if no SAML login has been performed.
Example: "OKTA"
When the account was last logged into using SAML, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Whether or not this account has been logged into with Okta SWA
Example: true
When the account was last logged into using Okta SWA, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Whether or not this account has an associated vendor SSO provider.
Example: "GOOGLE_WORKSPACE"
The identity provider that was used to do a FedCM login on this account. This is null if no FedCM login has been performed.
Example: "GOOGLE_WORKSPACE"
When this account was created, formatted as a UNIX timestamp (in seconds)
Example: 1698064423
Response
application/json
{ "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, "lastPasswordLoginTimestamp": 1698064423, "oidcLogin": "GOOGLE_WORKSPACE", "lastOidcLoginTimestamp": 1698064423, "samlLogin": "OKTA", "lastSamlLoginTimestamp": 1698064423, "oktaSwaLogin": true, "lastOktaSwaLoginTimestamp": 1698064423, "vendorSsoLogin": "GOOGLE_WORKSPACE", "fedCmLogin": "GOOGLE_WORKSPACE", "lastFedCmLoginTimestamp": 1698064423 }, "creationTimestamp": 1698064423, "lastUsedTimestamp": 1698669168 }