18 articles
Developers
API, OpenID Connect, SAML, webhooks, signed receipts and SDKs.
Start here
- APIThe AuthGuard API for integrators: overview and conventionsThe AuthGuard API serves each organization's address (for example https://<slug>.authguard.pt).
- APIAPI authentication (machine clients, SCIM tokens, OIDC clients)Each integration surface has its own credential.
- OpenID ConnectIntegrate an application with OpenID ConnectAuthGuard is an OpenID Connect provider. Your application uses the authorization code flow and receives a signed ID token.
- Approval requestsCreate an approval request (intents API)A system creates a request (intent) so that a person approves or declines one specific operation.
- SDKsAuthGuard SDKs (TypeScript, Python, Java, .NET, Go)The SDKs cover the integration surface (not the administration API), with the same behaviour in all five languages.
API5 articles
- The AuthGuard API for integrators: overview and conventionsThe AuthGuard API serves each organization's address (for example https://<slug>.authguard.pt).
- API authentication (machine clients, SCIM tokens, OIDC clients)Each integration surface has its own credential.
- /v1/meta: features served and organization stateGET /v1/meta is public and identical for every request to the same address.
- API errors and request limitsEvery API route returns errors in one envelope.
- The OpenAPI contractThe API's public contract is an OpenAPI 3.1 document kept next to the code: docs/openapi/authguard-v1.yaml, with the…
Approval requests4 articles
- Create an approval request (intents API)A system creates a request (intent) so that a person approves or declines one specific operation.
- Decision webhooks (Standard Webhooks)The service tells your system about decisions with webhooks signed according to the Standard Webhooks specification.
- Read a request's decision and cancel itAfter creating a request, the system learns the decision by reading the request or receiving a webhook.
- Verify a decision's signed receiptEvery decision on a request comes with a signed receipt that your system can verify without depending on the service.
OpenID Connect1 article
Privileged access (PAM)1 article
SAML1 article
SDKs6 articles
- AuthGuard SDKs (TypeScript, Python, Java, .NET, Go)The SDKs cover the integration surface (not the administration API), with the same behaviour in all five languages.
- .NET SDKThe AuthGuard.Sdk package uses Microsoft.IdentityModel.JsonWebTokens.
- Go SDKThe Go SDK lives in the repository's sdks/go folder (package authguard) and uses go-oidc/v3 with go-jose/v4.
- Java SDKThe pt.authguard:authguard-sdk artifact uses Nimbus JOSE+JWT.
- Python SDKThe authguard-sdk package (imported as authguard) uses PyJWT for JWTs.
- TypeScript / Node.js SDKThe @authguard/sdk package targets Node.js and uses jose for JWTs.