nextAuth API
API for the nextAuth server
Identity & security#openapi#security
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API for the nextAuth server
Endpoints 55
HTML
- GETGenerate HTML to enrol a new user
/servers/:serverid/sessions/html/enrol?name=string&userid=stringGenerate HTML to enrol a new user. Required permission: 'sessions'. - GETGeneric HTML to add to footer. Required for login/logout/enrol functionality.
/servers/:serverid/sessions/html/footerHTML to add to footer of HTML page. Required permission: 'sessions'. - GETGenerate HTML for the login block
/servers/:serverid/sessions/html/loginGenerate HTML for the login block. Required permission: 'sessions'.
Sessions
- POSTPush a login confirmation to the user's app
/servers/:serverid/accounts/:accountid/provokeloginPush a login to the nextAuth app for the user to confirm, based on the given account (app instance). Required permission: 'sessions' or 'accounts'. - GETCheck if the user is logged in
/servers/:serverid/sessions/Based on the browser/webserver session identifier, check if the user is logged in and return the associated username. This also returns additional… - POSTForce a logout on the given session
/servers/:serverid/sessions/logoutForce a logout on the given session. Required permission: 'sessions'. - POSTPush a login confirmation to the user's app
/servers/:serverid/sessions/provokeloginPush a login to the nextAuth app for the user to confirm, based on last account that successfully logged in for the given session. Required permission:… - GETGenerate data for a login qr code
/servers/:serverid/sessions/qr/login?img=string&s=0Returns the data for a login qr code. Required permission: 'sessions'. - POSTPush a login confirmation to the user's app
/servers/:serverid/users/:userid/provokeloginPush a login to the nextAuth app for the user to confirm, based on the given userid. Required permission: 'sessions' or 'users'.
Registration
- GETGenerate data for an enrol qr code
/servers/:serverid/sessions/qr/enrol?name=string&userid=string&img=string&s=0Returns the data for an enrol qr code. Required permission: 'sessions'. - GETVisual hash of this server
/servers/:serverid/vashReturns a PNG of the visual hash corresponding to this server. This visual hash is used during the registration process (optional), for the user to verify…
Users
- POSTRegister a userid for the currently logged in account.
/servers/:serverid/sessions/registeruser?userid=stringRegister a user for the currently logged in account. You can also directly pass a user name when generating an ENROL qr code. Required permission: 'users'. - GETGet all users
/servers/:serverid/users/?filter=string&search=string&limit=0&marker=0&sort=stringReturns an array of arrays containing all accounts corresponding to all users. Required permission: 'users'. - DELETEDelete a specific user
/servers/:serverid/users/:userid/Delete a user. Required permission: 'users'. - GETGet all accounts of a specific user
/servers/:serverid/users/:userid/accounts?limit=0&marker=0&sort=stringReturns an array containing all accounts corresponding to this user. Required permission: 'sessions' or 'users'. - DELETEDelete all accounts of a specific user
/servers/:serverid/users/:userid/accountsDelete all accounts corresponding to this user. The user itself is not deleted. Required permission: 'accounts' or 'users'. - GETGet all attributes of a specific user
/servers/:serverid/users/:userid/attributes/Returns an array containing all attributes corresponding to this user. Required permission: 'sessions' or 'users'. - PUTUpdate specified attributes of a specific user
/servers/:serverid/users/:userid/attributes/Update the specified attributes of a specific user. Prior attributes with keys that are not provided in the body of the request will not be deleted. Required… - POSTSet all attributes of a specific user
/servers/:serverid/users/:userid/attributes/Set the attributes of a specific user. Prior attributes with keys that are not provided in the body of the request will be deleted. Creates the user if not… - DELETEDelete all attributes of a specific user
/servers/:serverid/users/:userid/attributes/Delete all attributes of a specific user. Required permission: 'users'. - DELETEDelete specific attribute of a specific user
/servers/:serverid/users/:userid/attributes/:attributekeyDelete attribute with the specified key of a specific user. Required permission: 'users'.
Accounts
- GETGet all accounts
/servers/:serverid/accounts/?filter=string&limit=0&marker=0&sort=stringReturns all account. Required permission 'accounts'. - GETGet specific account
/servers/:serverid/accounts/:accountid/Returns the account. Required permission: 'sessions' or 'accounts'. - PUTUpdate specific account
/servers/:serverid/accounts/:accountid/?blocked=trueUpdate an account. The only available change is (un)blocking the account. Required permission: 'accounts'. - DELETEDelete specific account
/servers/:serverid/accounts/:accountid/Delete an account. Required permission: 'accounts'. - PUTUpdate user of the given account.
/servers/:serverid/accounts/:accountid/user?userid=stringUpdate the user of the given account. Required permission: 'accounts'.
Transactions
- POSTCreate a transaction to be approved within the current session.
/servers/:serverid/sessions/transactionsCreate a transaction for approval within the current session. Required permission: 'sessions'. - GETGet transaction result for a given transaction.
/servers/:serverid/transactions/:transactionidGet transaction result for a given transaction id. Required permission: 'sessions'.
Servers
- GETList all your servers
/servers/?limit=0&marker=0List all the servers you have the permissions for. Required permission: 'servers'. - POSTCreate a new server
/servers/Create a new server. Required permission: global 'createserver'. - GETConfiguration of a specific server
/servers/:serverid/Returns the configuration of a specific server. Required permission: 'servers' or 'createserver'. - PUTUpdate configuration of a specific server
/servers/:serverid/Update the configuration of a specific server. Required permission: 'createserver'. - GETGet all attributes of a specific server
/servers/:serverid/attributes/Returns an array containing all attributes corresponding to this server. Required permission: 'servers'. - PUTUpdate specified attributes of a specific server
/servers/:serverid/attributes/Update the specified attributes of a specific server. Prior attributes with keys that are not provided in the body of the request will not be deleted.… - POSTSet all attributes of a specific server
/servers/:serverid/attributes/Set the attributes of a specific server. Prior attributes with keys that are not provided in the body of the request will be deleted. Required permission:… - DELETEDelete all attributes of a specific server
/servers/:serverid/attributes/Delete all attributes of a specific server. Required permission: 'servers'. - DELETEDelete specific attribute of a specific server
/servers/:serverid/attributes/:attributekeyDelete attribute with the specified key of a specific server. Required permission: 'servers'.
Management
- GETGet all API keys.
/apikeys/Get all API keys generated by the current role. Required permission: global 'servers'. - POSTCreate a new API key.
/apikeys/?description=stringCreate a new API key. Required permission: global 'servers'. - GETGet all permissions for the specified server.
/servers/:serverid/permissions/Returns all permissions. Required permission: 'servers'. - GETGet all permissions for the specified server and role.
/servers/:serverid/permissions/:roleidReturns all permissions. Required permission: 'servers'. - POSTSet new permissions for the specified role on a server
/servers/:serverid/permissions/:roleidSet new permissions for the specified role on a server. This overwrites any existing permissions on this server for the specified role. Required permission:… - DELETERevoke all permissions for the specified server and role.
/servers/:serverid/permissions/:roleidRevoke all permissions for the specified server and role. Required permission: 'root'. - GETGet role for a specific user.
/servers/:serverid/users/:userid/role/Get role for a specific user. Required permission: 'users'. - POSTGet or create a role for a specific user.
/servers/:serverid/users/:userid/role/Get or create a role for a specific user. Required permission: 'users'.
Global
- GETGet all global attributes
/attributes/Returns an array containing all global attributes. Required permission: global 'servers'. - PUTUpdate specified global attributes
/attributes/Update the specified global attributes. Prior attributes with keys that are not provided in the body of the request will not be deleted. Required permission:… - POSTSet all global attributes
/attributes/Set the global attributes. Prior attributes with keys that are not provided in the body of the request will be deleted. Required permission: global 'servers'. - DELETEDelete all global attributes
/attributes/Delete all global attributes. Required permission: global 'servers'. - DELETEDelete specific global attribute
/attributes/:attributekeyDelete global attribute with the specified key. Required: global 'servers'. - GETGet all privileged attributes of a specific server
/servers/:serverid/privilegedattributes/Returns an array containing all privileged attributes corresponding to this server. Required permission: global 'servers'. - PUTUpdate privileged specified attributes of a specific server
/servers/:serverid/privilegedattributes/Update the specified privileged attributes of a specific server. Prior privileged attributes with keys that are not provided in the body of the request will… - POSTSet all privileged attributes of a specific server
/servers/:serverid/privilegedattributes/Set the privileged attributes of a specific server. Prior attributes with keys that are not provided in the body of the request will be deleted. Required… - DELETEDelete all privileged attributes of a specific server
/servers/:serverid/privilegedattributes/Delete all privileged attributes of a specific server. Required permission: global 'servers'. - DELETEDelete specific privileged attribute of a specific server
/servers/:serverid/privilegedattributes/:attributekeyDelete privileged attribute with the specified key of a specific server. Required permission: global 'servers'.
API details
- Base URL
https://api.nextauth.com- Authentication
- An API key in the X-apikey header
An API key in the X-su header - Operations
- 55 operations on 34 pathsGET 22POST 14DELETE 12PUT 7
- Main resources
- Global 10Users 10Servers 9Management 8Accounts 7Sessions 6HTML 5Registration 4Transactions 2
- Response formats
application/json- Description format
- Swagger 2.0, API version
2.2 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the nextAuth API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the nextAuth API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-apikey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Generate HTML to enrol a new user” (GET /servers/:serverid/sessions/html/enrol?name=string&userid=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the nextAuth API?
API for the nextAuth server It is listed under Identity & security and has 55 endpoints.
Who publishes the nextAuth API?
It is listed from n-auth's public API description (an OpenAPI document), not published by n-auth on Swastik Codes. Anyone who controls n-auth.com can claim the profile by adding a DNS TXT record.
What is the base URL of the nextAuth API?
Requests go to https://api.nextauth.com. Endpoint paths are added to this base URL.
How do I authenticate with the nextAuth API?
It accepts 2 methods: an API key in the X-apikey header; an API key in the X-su header.
How many endpoints does the nextAuth API have?
55 operations on 34 paths (22 GET, 14 POST, 12 DELETE, 7 PUT). The largest groups are Global, Users, Servers, Management.
Is forking the nextAuth API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.