{"@context": "https://schema.org", "@type": "WebAPI", "name": "nextAuth API API", "description": "API for the nextAuth server", "provider": {"@type": "Organization", "name": "n-auth.com"}, "documentation": "https://api.docs.nextauth.com/api/swagger.json"}
Index / APIs / n-auth.com

nextAuth API API

API for the nextAuth server

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://api.nextauth.com

auth: a p i k e y

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

nextAuth API v2.2

API for the nextAuth server

methodpathwhat the vendor says it does
GET/apikeys/Get all API keys. Get all API keys generated by the current role. Required permission: global 'servers'. Manag
POST/apikeys/Create a new API key. Create a new API key. Required permission: global 'servers'. Management
GET/attributes/Get all global attributes Returns an array containing all global attributes. Required permission: global 'serv
POST/attributes/Set all global attributes Set the global attributes. Prior attributes with keys that are not provided in the b
PUT/attributes/Update specified global attributes Update the specified global attributes. Prior attributes with keys that are
DELETE/attributes/Delete all global attributes Delete all global attributes. Required permission: global 'servers'. Global
DELETE/attributes/{attributekey}Delete specific global attribute Delete global attribute with the specified key. Required: global 'servers'. G
GET/servers/List all your servers List all the servers you have the permissions for. Required permission: 'servers'. Serve
POST/servers/Create a new server Create a new server. Required permission: global 'createserver'. Servers
GET/servers/{serverid}/Configuration of a specific server Returns the configuration of a specific server. Required permission: 'serve
PUT/servers/{serverid}/Update configuration of a specific server Update the configuration of a specific server. Required permission:
GET/servers/{serverid}/accounts/Get all accounts Returns all account. Required permission 'accounts'. Accounts
GET/servers/{serverid}/accounts/{accountid}/Get specific account Returns the account. Required permission: 'sessions' or 'accounts'. Accounts
PUT/servers/{serverid}/accounts/{accountid}/Update specific account Update an account. The only available change is (un)blocking the account. Required per
DELETE/servers/{serverid}/accounts/{accountid}/Delete specific account Delete an account. Required permission: 'accounts'. Accounts
POST/servers/{serverid}/accounts/{accountid}/provokeloginPush a login confirmation to the user's app Push a login to the nextAuth app for the user to confirm, based on
PUT/servers/{serverid}/accounts/{accountid}/userUpdate user of the given account. Update the user of the given account. Required permission: 'accounts'. Accou
GET/servers/{serverid}/attributes/Get all attributes of a specific server Returns an array containing all attributes corresponding to this serve
POST/servers/{serverid}/attributes/Set all attributes of a specific server Set the attributes of a specific server. Prior attributes with keys th
PUT/servers/{serverid}/attributes/Update specified attributes of a specific server Update the specified attributes of a specific server. Prior a
DELETE/servers/{serverid}/attributes/Delete all attributes of a specific server Delete all attributes of a specific server. Required permission: 's
DELETE/servers/{serverid}/attributes/{attributekey}Delete specific attribute of a specific server Delete attribute with the specified key of a specific server. R
GET/servers/{serverid}/permissions/Get all permissions for the specified server. Returns all permissions. Required permission: 'servers'. Managem
GET/servers/{serverid}/permissions/{roleid}Get all permissions for the specified server and role. Returns all permissions. Required permission: 'servers'
POST/servers/{serverid}/permissions/{roleid}Set new permissions for the specified role on a server Set new permissions for the specified role on a server.
DELETE/servers/{serverid}/permissions/{roleid}Revoke all permissions for the specified server and role. Revoke all permissions for the specified server and
GET/servers/{serverid}/privilegedattributes/Get all privileged attributes of a specific server Returns an array containing all privileged attributes corre
POST/servers/{serverid}/privilegedattributes/Set all privileged attributes of a specific server Set the privileged attributes of a specific server. Prior a
PUT/servers/{serverid}/privilegedattributes/Update privileged specified attributes of a specific server Update the specified privileged attributes of a sp
DELETE/servers/{serverid}/privilegedattributes/Delete all privileged attributes of a specific server Delete all privileged attributes of a specific server. R
DELETE/servers/{serverid}/privilegedattributes/{attributekey}Delete specific privileged attribute of a specific server Delete privileged attribute with the specified key o
GET/servers/{serverid}/sessions/Check if the user is logged in Based on the browser/webserver session identifier, check if the user is logged
GET/servers/{serverid}/sessions/html/enrolGenerate HTML to enrol a new user Generate HTML to enrol a new user. Required permission: 'sessions'. HTML
GET/servers/{serverid}/sessions/html/footerGeneric HTML to add to footer. Required for login/logout/enrol functionality. HTML to add to footer of HTML pa
GET/servers/{serverid}/sessions/html/loginGenerate HTML for the login block Generate HTML for the login block. Required permission: 'sessions'. HTML
POST/servers/{serverid}/sessions/logoutForce a logout on the given session Force a logout on the given session. Required permission: 'sessions'. Sess
POST/servers/{serverid}/sessions/provokeloginPush a login confirmation to the user's app Push a login to the nextAuth app for the user to confirm, based on
GET/servers/{serverid}/sessions/qr/enrolGenerate data for an enrol qr code Returns the data for an enrol qr code. Required permission: 'sessions'. Reg
GET/servers/{serverid}/sessions/qr/loginGenerate data for a login qr code Returns the data for a login qr code. Required permission: 'sessions'. Sessi
POST/servers/{serverid}/sessions/registeruserRegister a userid for the currently logged in account. Register a user for the currently logged in account. Yo

and 15 more operation(s) in this specification, all searchable.

specification origin: https://api.docs.nextauth.com/api/swagger.json

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.