Open documentation ↗Overview
API for the nextAuth server
nextAuth API is a security API from n-auth.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 55 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Security
- Base URL
https://api.nextauth.com/- Version
- 2.2
- Endpoints
- 55
- OpenAPI
- Specification ↗
- Spec updated
- 2021-04-07
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.nextauth.com/apikeys/" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://api.nextauth.com/apikeys/", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.nextauth.com/apikeys/",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /apikeys/ | Get all API keys. |
| POST | /apikeys/ | Create a new API key. |
| GET | /attributes/ | Get all global attributes |
| POST | /attributes/ | Set all global attributes |
| PUT | /attributes/ | Update specified global attributes |
| DELETE | /attributes/ | Delete all global attributes |
| DELETE | /attributes/{attributekey} | Delete specific global attribute |
| GET | /servers/ | List all your servers |
| POST | /servers/ | Create a new server |
| GET | /servers/{serverid}/ | Configuration of a specific server |
| PUT | /servers/{serverid}/ | Update configuration of a specific server |
| GET | /servers/{serverid}/accounts/ | Get all accounts |
| GET | /servers/{serverid}/accounts/{accountid}/ | Get specific account |
| PUT | /servers/{serverid}/accounts/{accountid}/ | Update specific account |
| DELETE | /servers/{serverid}/accounts/{accountid}/ | Delete specific account |
| POST | /servers/{serverid}/accounts/{accountid}/provokelogin | Push a login confirmation to the user's app |
| PUT | /servers/{serverid}/accounts/{accountid}/user | Update user of the given account. |
| GET | /servers/{serverid}/attributes/ | Get all attributes of a specific server |
| POST | /servers/{serverid}/attributes/ | Set all attributes of a specific server |
| PUT | /servers/{serverid}/attributes/ | Update specified attributes of a specific server |
| DELETE | /servers/{serverid}/attributes/ | Delete all attributes of a specific server |
| DELETE | /servers/{serverid}/attributes/{attributekey} | Delete specific attribute of a specific server |
| GET | /servers/{serverid}/permissions/ | Get all permissions for the specified server. |
| GET | /servers/{serverid}/permissions/{roleid} | Get all permissions for the specified server and role. |
| POST | /servers/{serverid}/permissions/{roleid} | Set new permissions for the specified role on a server |
| DELETE | /servers/{serverid}/permissions/{roleid} | Revoke all permissions for the specified server and role. |
| GET | /servers/{serverid}/privilegedattributes/ | Get all privileged attributes of a specific server |
| POST | /servers/{serverid}/privilegedattributes/ | Set all privileged attributes of a specific server |
| PUT | /servers/{serverid}/privilegedattributes/ | Update privileged specified attributes of a specific server |
| DELETE | /servers/{serverid}/privilegedattributes/ | Delete all privileged attributes of a specific server |
| DELETE | /servers/{serverid}/privilegedattributes/{attributekey} | Delete specific privileged attribute of a specific server |
| GET | /servers/{serverid}/sessions/ | Check if the user is logged in |
| GET | /servers/{serverid}/sessions/html/enrol | Generate HTML to enrol a new user |
| GET | /servers/{serverid}/sessions/html/footer | Generic HTML to add to footer. Required for login/logout/enrol functionality. |
| GET | /servers/{serverid}/sessions/html/login | Generate HTML for the login block |
| POST | /servers/{serverid}/sessions/logout | Force a logout on the given session |
| POST | /servers/{serverid}/sessions/provokelogin | Push a login confirmation to the user's app |
| GET | /servers/{serverid}/sessions/qr/enrol | Generate data for an enrol qr code |
| GET | /servers/{serverid}/sessions/qr/login | Generate data for a login qr code |
| POST | /servers/{serverid}/sessions/registeruser | Register a userid for the currently logged in account. |
| POST | /servers/{serverid}/sessions/transactions | Create a transaction to be approved within the current session. |
| GET | /servers/{serverid}/transactions/{transactionid} | Get transaction result for a given transaction. |
| GET | /servers/{serverid}/users/ | Get all users |
| DELETE | /servers/{serverid}/users/{userid}/ | Delete a specific user |
| GET | /servers/{serverid}/users/{userid}/accounts | Get all accounts of a specific user |
| DELETE | /servers/{serverid}/users/{userid}/accounts | Delete all accounts of a specific user |
| GET | /servers/{serverid}/users/{userid}/attributes/ | Get all attributes of a specific user |
| POST | /servers/{serverid}/users/{userid}/attributes/ | Set all attributes of a specific user |
| PUT | /servers/{serverid}/users/{userid}/attributes/ | Update specified attributes of a specific user |
| DELETE | /servers/{serverid}/users/{userid}/attributes/ | Delete all attributes of a specific user |
| DELETE | /servers/{serverid}/users/{userid}/attributes/{attributekey} | Delete specific attribute of a specific user |
| POST | /servers/{serverid}/users/{userid}/provokelogin | Push a login confirmation to the user's app |
| GET | /servers/{serverid}/users/{userid}/role/ | Get role for a specific user. |
| POST | /servers/{serverid}/users/{userid}/role/ | Get or create a role for a specific user. |
| GET | /servers/{serverid}/vash | Visual hash of this server |
Questions
Does the nextAuth API API need an API key?
Yes. The nextAuth API API uses API key authentication; the documentation explains how to get credentials.
Does the nextAuth API API support HTTPS?
Yes, the nextAuth API API is served over HTTPS.
How many endpoints does the nextAuth API API have?
Its OpenAPI description lists 55 endpoints in version 2.2. All of them are shown on this page.
What are alternatives to the nextAuth API API?
Other Security APIs include Microsoft Security Response Center (MSRC), National Vulnerability Database, Cisco PSIRT openVuln API, Shodan, BitWarden.
Similar security APIs
Compare alternatives →Microsoft Security Response Center (MSRC)
SecurityProgrammatic interfaces to engage with the Microsoft Security Response Center (MSRC)
National Vulnerability Database
SecurityU.S. National Vulnerability Database
Cisco PSIRT openVuln API
SecurityThe Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information). For more information about the Cisco PSIRT openVuln API visit https://developer.cisco.com/site/PSIRT/discover/overview For detail steps on how to use the API go to:https://developer.cisco.com/site/PSIRT/get-started/getting-started.gsp This is a beta release of a swagger YAML for the Cisco PSIRT openVuln API To access the API sign in with your Cisco CCO account at http://apiconsole.cisco.com and register an application to recieve a client_id and a client_secret You can then get your token using curl or any other method you prefer. 'curl -s -k -H "Content-Type: application/x-www-form-urlencoded" -X POST -d "client_id=<your_client_id>" -d "client_secret=<your_client_secret>" -d "grant_type=client_credentials" https://cloudsso.cisco.com/as/token.oauth2' You will receive an access token as demonstrated in the following example: '{"access_token":"I7omWtBDAieSiUX3shOxNJfuy4J6","token_type":"Bearer","expires_in":3599}' In Swagger, click on Change Authentication enter the text "I7omWtBDAieSiUX3shOxNJfuy4J6" (which is the token you received) then click on "Try this operation"
Shodan
SecuritySearch engine for Internet connected devices
BitWarden
SecurityBest open-source password manager
HaveIBeenPwned
SecurityPasswords which have previously been exposed in data breaches
Listed from APIs.guru (CC0).