User Management
The User Management APIs are provided by nevisIDM. They cover user profiles, user data, credentials, roles, terms and conditions, and SCIM 2.0 operations.
These APIs are not exposed by default. You have two main options:
- Within an authentication flow: Call these APIs from a nevisAuth ScriptState using a SecToken for authentication.
- Exposed to external clients: Use the nevisIDM REST Service pattern or the REST Service pattern. The pattern defines the path and the authentication required to call the endpoint.
The request and response behavior of these APIs can depend on the nevisIDM configuration, for example the data model, property definitions, and policy settings.
Endpoints in this section
| Path | Methods | Purpose |
|---|---|---|
/nevisidm/api/core/v1/{clientExtId}/users | POST | Create a user |
/nevisidm/api/core/v1/{clientExtId}/users/{extId} | GET, DELETE, PATCH | Read, update, or delete a user |
/nevisidm/api/core/v1/{clientExtId}/users/{extId}/archive | POST | Archive a user |
/nevisidm/api/query/v1/users | GET | Query users |
/nevisidm/api/core/v1/clients/{extId}/users | GET | List users of a client |
/nevisidm/api/core/v1/{clientExtId}/users/{extId}/credentials | GET | List all credentials of a user |
/nevisidm/api/principal/v1/me | GET | Get the current caller's user info |
/nevisidm/api/principal/v1/permissions | GET | Get the current caller's permissions |
/nevisidm/api/core/v1/{clientExtId}/users/{extId}/profiles | GET, POST | List or create profiles of a user |
/nevisidm/api/core/v1/{clientExtId}/profiles/{extId} | GET, DELETE, PATCH | Read, update, or delete a profile |
/nevisidm/api/core/v1/properties | GET, POST | Search or create property definitions |
/nevisidm/api/core/v1/{clientExtId}/users/{extId}/properties | GET, PATCH | Get or update user properties |
/nevisidm/api/scim/v1/{clientExtId}/Users | GET, POST | List or create users via SCIM 2.0 |
/nevisidm/api/scim/v1/{clientExtId}/Users/.search | POST | Search users via SCIM 2.0 |
/nevisidm/api/scim/v1/{clientExtId}/Users/{id} | GET, DELETE, PATCH | Read, update, or delete a user via SCIM 2.0 |
/nevisidm/api/scim/v1/{clientExtId}/Bulk | POST | Bulk SCIM operations |
/nevisidm/api/core/v1/terms | GET, POST | List or create terms objects |
/nevisidm/api/core/v1/terms/{extId} | GET, DELETE, PATCH | Read, update, or delete a terms object |
/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/consents | GET, POST | List or create consents of a user |
/nevisidm/api/core/v1/{clientExtId}/users/{userExtId}/terms-pending | GET | List pending terms for a user |