Integration, APIs, and Provisioning
Nevis ID is API-first: REST APIs cover users, credentials, clients, federation, configuration, and reporting, documented in a complete OpenAPI-based reference, with the API version determined by the Nevis ID release you deploy and access granted through an API key issued to a service account. Provisioning runs over SCIM 2.0 inbound and as continuous outbound synchronization with Nevis as the system of record, complemented by bulk import and just-in-time creation on first federated login. Applications integrate through the Mobile Authentication SDK (iOS, Android, Flutter, React Native) and third-party systems such as a CRM, a support tool, or a CDP connect through the APIs. Configuration is code: journeys and settings live in versioned, validated projects with audited changes, instant rollback, and TEST to LIVE promotion.
Also known as
application development and integration, API access control, API key, API token, service account, machine-to-machine authentication, non-human identity, SDKs, SCIM provisioning, CRM/CDP/marketing connectors, ITSM.
At a glance
| Capability | Details |
|---|---|
| REST APIs | APIs across users, credentials, clients, federation, configuration, and reporting; complete OpenAPI-based reference |
| API access control | By default, Nevis ID APIs are called with an API key: a long-lived, opaque bearer token issued to a service account |
| Nevis ID API protection | DDoS protection and rate limiting with over-usage throttling; quantum-resistant TLS (TLS 1.3 with ML-KEM) at the edge |
| SDKs and integration libraries | Mobile Authentication SDK for iOS, Android, Flutter, and React Native |
| SCIM provisioning | SCIM 2.0 inbound; continuous outbound synchronization with Nevis as the system of record |
| Migration and bulk import | Migration tooling with continuous sync and bulk import; see also Registration, Onboarding, and Identity Verification |
| Lifecycle provisioning | Full user, profile, and credential lifecycle over the APIs, including states, archiving, and deprovisioning |
| JIT provisioning | Just-in-time creation on first federated login over SCIM, SAML, OIDC, or REST |
| Third-party integration paths | CRM, support and ticketing, CDP, and internal systems connect through the APIs; any SMTP server for outbound email; SIEM forwarding (see Reporting, Analytics, and Audit); risk, session, and device data is available over the APIs for correlation in an external fraud platform (see Risk, Fraud, and Adaptive Access) |
| Directory integration | Migration from LDAP and Active Directory over SCIM; corporate directories federate over OIDC or SAML, including AD FS estates where Nevis adds passkey and mobile MFA inside the estate (see Federation and SSO) |
| Configuration as code | Versioned declarative configuration with validation, audited changes, and instant rollback; TEST to LIVE promotion |
Concepts
- Client and tenant management APIs: how tenants, organizational units and applications are administered
- Configuration and setup management APIs: how federation setups and their snapshots are managed
How-to Guides
- How to use the API: create API access, obtain tokens, and query the APIs
- Migrate users over SCIM: an eight-part guide from planning to continuous sync
- Manage secrets in the console
- Console overview
References
- API reference sections: Authentication and login, Federation and social login, Credential management, User management, Client and tenant management, Configuration and setup management, Reporting, System
- Provisioning and data APIs: SCIM 2.0, Query data, Properties, Notification
- API patterns: Gateway API Rate Limit Rule for rate limiting, and Access Token Consumer for integrators who configure access token validation themselves
- SDK and library references: Mobile Authentication SDK API references
- Configuration as code: nevisAdmin 4 version control with Git
- Data model and the system overview