How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PassiveLogic Authentication API

Routes related to user auth

PassiveLogic Authentication API is one of 18 APIs that PassiveLogic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 72 operations across 63 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against the base URL https://passivelogic.com/api/.

72 operations 63 paths 19 schemas 6 DELETE36 GET30 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://passivelogic.com/api/
Authentication
API Key, HTTP Basic, API Key, API Key
Resource Areas
1

Authentication & Security 4

PassiveLogic Authentication API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-PL-AUTH (XSRF_header). It accepts HTTP basic authentication (Basic_Auth_-_login). An API key is passed in the header as PL-API-KEY (PL_API_Key). An API key is passed in the header as Authorization: PL-API-KEY (DEPRECATED_-_PL_API_Key).

  • XSRF_header — Authentication using an XSRF protected JWT
  • Basic_Auth_-_login — Basic authentication used only at login.
  • PL_API_Key — PL API Key in header
  • DEPRECATED_-_PL_API_Key — DEPRECATED - PL API Key in Bearer header

Paths & Operations 72

Across 63 paths, the API surfaces 72 operations — 6 DELETE, 36 GET, 30 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 72

Routes related to user auth

GET
/api/v0.20/auth/email/change/verifydeprecated
Verifies and updates new user email
getApiV0.20AuthEmailChangeVerify body → 200
POST
/api/auth/magic-link-generatedeprecated
Generates a Magic Link to be used to login.
postApiAuthMagic-link-generate body → 200
GET
/api/v0.19/auth/email/change/verifydeprecated
Verifies and updates new user email
getApiV0.19AuthEmailChangeVerify body → 200
GET
/api/auth/email/change/verifydeprecated
Verifies and updates new user email
getApiAuthEmailChangeVerify body → 200
POST
/api/auth/password/changedeprecated
Changes a user's password for an already authenticated user.
postApiAuthPasswordChange body → 200
GET
/api/auth/password/change
Redirects the user to the change password flow in the external auth provider (Keycloak).
getApiAuthPasswordChange
POST
/api/v0.19/auth/password/resetdeprecated
Initiates a password reset.
postApiV0.19AuthPasswordReset body → 200
GET
/api/v0.20/auth/logindeprecated
Logs in a user
getApiV0.20AuthLogin → 200
GET
/api/v0.19/auth/logindeprecated
Logs in a user
getApiV0.19AuthLogin → 200
DELETE
/api/v0.20/auth/api-key
Removes a given API key for the user
deleteApiV0.20AuthApi-key body → 200
POST
/api/auth/registerdeprecated
Registers a new user
postApiAuthRegister body → 200
GET
/api/auth/logindeprecated
Logs in a user
getApiAuthLogin → 200
POST
/api/v0.20/auth/logout
Logs out a user
postApiV0.20AuthLogout → 200
GET
/api/v0.19/auth/zendesk
Logs a user in to Zendesk using their PL Account
getApiV0.19AuthZendesk
GET
/api/v0.19/auth/verify
Redirects user to login
getApiV0.19AuthVerify 1 param
GET
/api/auth/keys
Returns the public keys used to sign PassiveLogic JSON web tokens.
getApiAuthKeys → 200
POST
/api/auth/password/resetdeprecated
Initiates a password reset.
postApiAuthPasswordReset body → 200
GET
/api/v0.20/auth/whoami
Returns information about the currently logged in user.
getApiV0.20AuthWhoami → 200
GET
/api/v0.20/auth/verify
Redirects user to login
getApiV0.20AuthVerify 1 param
GET
/api/auth/magic-link-logindeprecated
Logs in a user using Magic Link generated by POST magic-link-generate
getApiAuthMagic-link-login → 200
POST
/api/v0.19/auth/registerdeprecated
Registers a new user
postApiV0.19AuthRegister body → 200
GET
/api/auth/api-key/generate
Generates an API key for the current user
getApiAuthApi-keyGenerate 2 params → 200
GET
/api/v0.20/auth/keys
Returns the public keys used to sign PassiveLogic JSON web tokens.
getApiV0.20AuthKeys → 200
DELETE
/api/v0.19/auth/api-key
Removes a given API key for the user
deleteApiV0.19AuthApi-key body → 200
POST
/api/auth/password/reset/changedeprecated
Changes a user's password from the password reset flow.
postApiAuthPasswordResetChange body → 200
GET
/api/auth/offline
GET /auth/offline
POST
/api/auth/register/initiatedeprecated
Sends an email to begin email verification and registration.
postApiAuthRegisterInitiate body → 200
GET
/api/auth/verify
Redirects user to login
getApiAuthVerify 1 param
DELETE
/api/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/auth/api-key.
deleteApiAuthApi-keyRemove body → 200
POST
/api/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/auth/api-key.
postApiAuthApi-keyRemove body → 200
POST
/api/v0.19/auth/logout
Logs out a user
postApiV0.19AuthLogout → 200
POST
/api/v0.20/auth/registerdeprecated
Registers a new user
postApiV0.20AuthRegister body → 200
GET
/api/v0.19/auth/offline
GET /auth/offline
POST
/api/v0.20/auth/magic-link-generatedeprecated
Generates a Magic Link to be used to login.
postApiV0.20AuthMagic-link-generate body → 200
POST
/api/v0.20/auth/password/changedeprecated
Changes a user's password for an already authenticated user.
postApiV0.20AuthPasswordChange body → 200
GET
/api/v0.20/auth/password/change
Redirects the user to the change password flow in the external auth provider (Keycloak).
getApiV0.20AuthPasswordChange
DELETE
/api/auth/api-key
Removes a given API key for the user
deleteApiAuthApi-key body → 200
GET
/api/v0.19/auth/keys
Returns the public keys used to sign PassiveLogic JSON web tokens.
getApiV0.19AuthKeys → 200
POST
/api/v0.20/auth/password/resetdeprecated
Initiates a password reset.
postApiV0.20AuthPasswordReset body → 200
POST
/api/auth/email/changedeprecated
Initiates an email change for the current user.
postApiAuthEmailChange body → 200
GET
/api/auth/profile/change
Redirects the user the change profile flow in the external auth provider (Keycloak).
getApiAuthProfileChange
DELETE
/api/v0.19/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/v0.19/auth/api-key.
deleteApiV0.19AuthApi-keyRemove body → 200
POST
/api/v0.19/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/v0.19/auth/api-key.
postApiV0.19AuthApi-keyRemove body → 200
GET
/api/v0.20/auth/profile/change
Redirects the user the change profile flow in the external auth provider (Keycloak).
getApiV0.20AuthProfileChange
POST
/api/v0.20/auth/password/reset/changedeprecated
Changes a user's password from the password reset flow.
postApiV0.20AuthPasswordResetChange body → 200
GET
/api/v0.19/auth/magic-link-logindeprecated
Logs in a user using Magic Link generated by POST magic-link-generate
getApiV0.19AuthMagic-link-login → 200
GET
/api/v0.20/auth/magic-link-logindeprecated
Logs in a user using Magic Link generated by POST magic-link-generate
getApiV0.20AuthMagic-link-login → 200
GET
/api/v0.20/auth/zendesk
Logs a user in to Zendesk using their PL Account
getApiV0.20AuthZendesk
POST
/api/v0.19/auth/password/reset/changedeprecated
Changes a user's password from the password reset flow.
postApiV0.19AuthPasswordResetChange body → 200
POST
/api/v0.20/auth/email/changedeprecated
Initiates an email change for the current user.
postApiV0.20AuthEmailChange body → 200
POST
/api/v0.20/auth/kc/{user}
Validates a user's password
postApiV0.20AuthKcByUser 1 param → 200
GET
/api/v0.20/auth/kc/{user}
Retrieves user information for Keycloak
getApiV0.20AuthKcByUser 1 param → 200
GET
/api/auth/whoami
Returns information about the currently logged in user.
getApiAuthWhoami → 200
POST
/api/auth/kc/{user}
Validates a user's password
postApiAuthKcByUser 1 param → 200
GET
/api/auth/kc/{user}
Retrieves user information for Keycloak
getApiAuthKcByUser 1 param → 200
POST
/api/v0.19/auth/password/changedeprecated
Changes a user's password for an already authenticated user.
postApiV0.19AuthPasswordChange body → 200
GET
/api/v0.19/auth/password/change
Redirects the user to the change password flow in the external auth provider (Keycloak).
getApiV0.19AuthPasswordChange
DELETE
/api/v0.20/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/v0.20/auth/api-key.
deleteApiV0.20AuthApi-keyRemove body → 200
POST
/api/v0.20/auth/api-key/removedeprecated
Removes a given API key for the user. This route has been deprecated in favor of: DELETE /api/v0.20/auth/api-key.
postApiV0.20AuthApi-keyRemove body → 200
GET
/api/v0.20/auth/api-key/generate
Generates an API key for the current user
getApiV0.20AuthApi-keyGenerate 2 params → 200
POST
/api/v0.19/auth/magic-link-generatedeprecated
Generates a Magic Link to be used to login.
postApiV0.19AuthMagic-link-generate body → 200
GET
/api/auth/zendesk
Logs a user in to Zendesk using their PL Account
getApiAuthZendesk
GET
/api/v0.19/auth/profile/change
Redirects the user the change profile flow in the external auth provider (Keycloak).
getApiV0.19AuthProfileChange
GET
/api/v0.19/auth/api-key/generate
Generates an API key for the current user
getApiV0.19AuthApi-keyGenerate 2 params → 200
POST
/api/auth/logout
Logs out a user
postApiAuthLogout → 200
POST
/api/v0.19/auth/kc/{user}
Validates a user's password
postApiV0.19AuthKcByUser 1 param → 200
GET
/api/v0.19/auth/kc/{user}
Retrieves user information for Keycloak
getApiV0.19AuthKcByUser 1 param → 200
GET
/api/v0.19/auth/whoami
Returns information about the currently logged in user.
getApiV0.19AuthWhoami → 200
POST
/api/v0.19/auth/register/initiatedeprecated
Sends an email to begin email verification and registration.
postApiV0.19AuthRegisterInitiate body → 200
POST
/api/v0.19/auth/email/changedeprecated
Initiates an email change for the current user.
postApiV0.19AuthEmailChange body → 200
POST
/api/v0.20/auth/register/initiatedeprecated
Sends an email to begin email verification and registration.
postApiV0.20AuthRegisterInitiate body → 200
GET
/api/v0.20/auth/offline
GET /auth/offline

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are KeycloakUserInfo (12 properties), RegisterUserData (9 properties), WhoAmIResponse (5 properties), RegisterUserResponse (5 properties). Each schema is shown below with its type and property counts.

RegisterUserData
object
Data required for user registration
9 properties 6 required
QuantumUserStatus
string
KeycloakUserInfo
object
Information for Keycloak about the requested user.
12 properties 1 required
JWKS
object
1 property 1 required
MagicLinkResponse
object
Email for use signing up with a magic link
2 properties
GenerateApiKeyResponse
object
New API key generated for a user.
2 properties 2 required
LoginResponse
object
Generic response information
3 properties 3 required
JWK
object
1 property 1 required
ChangeUserPassword
object
Information required to change a user's password from the authenticated change password flow
2 properties 2 required
RegisterUserResponse
object
Sent when a new user is successfully registered.
5 properties 1 required
GenericMessageResponse
object
Generic response information
1 property 1 required
RequestResetPasswordData
object
Information required to request a password reset.
1 property 1 required
UserRegistrationInitiation
object
Information for intiating user registration
3 properties 1 required
UpdatedUserEmail
object
Information for changing a user's email
3 properties 3 required
ChangePasswordData
object
Information required to change a user's password from the reset password flow
2 properties 1 required
WhoAmIResponse
object
Information about the authenticated user
5 properties 1 required
QuantumObjectType
string
RemoveApiKeyRequest
object
API key to revoke
1 property 1 required
Identifier
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

passivelogic-authentication-api-openapi.yml Raw ↑

Other APIs PassiveLogic publishes across the network.

Quantum GraphQL API
PassiveLogic Account API
PassiveLogic API
PassiveLogic App API
PassiveLogic Auth Groups API
PassiveLogic Bindings API
PassiveLogic Default API
PassiveLogic Export API
PassiveLogic Graph QL API
PassiveLogic Health API
PassiveLogic Images API
PassiveLogic Organization API
Where this information came from

This is an independent, third-party profile of PassiveLogic Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.