Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NeuVector User API

Operations about User

NeuVector User API is one of 31 APIs that NeuVector publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.

This API exposes 15 operations across 8 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version 5.6.0.

Requests are made against the base URL https://localhost:10443.

15 operations 8 paths 26 schemas 2 DELETE6 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
5.6.0
Base URL
https://localhost:10443
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

NeuVector User API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Apikey (ApiKeyAuth). An API key is passed in the header as X-Auth-Token (TokenAuth).

Paths & Operations 15

Across 8 paths, the API surfaces 15 operations — 2 DELETE, 6 GET, 4 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

User 15

Operations about User

GET
/v1/password_profile
Get password profile list
→ 200
GET
/v1/password_profile/{name}
Get password profile
1 param → 200
PATCH
/v1/password_profile/{name}
Configure password profile
2 params → 200
GET
/v1/user
Gets a list of users
→ 200
POST
/v1/user
Creates a user
1 param → 200
GET
/v1/user/{fullname}
Gets a user
1 param → 200
PATCH
/v1/user/{fullname}
Update user
2 params → 200403
DELETE
/v1/user/{fullname}
Delete user
1 param → 200
POST
/v1/user/{fullname}/password
Configure user login
2 params → 200
PATCH
/v1/user/{fullname}/role/{role}
For CLI to modify one role
3 params → 200
GET
/v1/user_role
Get role list
→ 200
POST
/v1/user_role
Creates a role
1 param → 200
GET
/v1/user_role/{name}
Get role details
1 param → 200
PATCH
/v1/user_role/{name}
Config a user role
2 params → 200
DELETE
/v1/user_role/{name}
Delete a user role
1 param → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are RESTUser (20 properties), RESTPwdProfileConfig (16 properties), RESTPwdProfile (15 properties), RESTUserConfig (9 properties). Each schema is shown below with its type and property counts.

RESTUserRoleConfig
object
3 properties 3 required
RESTUserPwdConfigData
object
1 property 1 required
RESTUserPwdConfig
object
5 properties 1 required
RESTUserRoleData
object
1 property 1 required
RESTUserRoleDomainsConfigData
object
1 property 1 required
RESTPwdProfileBasic
object
5 properties 5 required
RESTUserRolesData
object
1 property 1 required
RESTImportTaskData
object
1 property 1 required
RESTPermitsAssigned
object
2 properties
RESTImportTask
object
8 properties 3 required
RESTUserConfigData
object
1 property 1 required
RESTUserData
object
1 property 1 required
RESTUserRoleDomainsConfig
object
3 properties 3 required
RESTUserConfig
object
9 properties 2 required
RESTPwdProfileConfig
object
16 properties 1 required
RESTPwdProfileData
object
1 property 1 required
RESTUser
object
20 properties 15 required
RESTPwdProfileConfigData
object
1 property 1 required
RESTRemoteRolePermits
object
4 properties 1 required
RESTError
object
5 properties 3 required
RESTPwdProfile
object
15 properties 15 required
RESTUserRoleConfigData
object
1 property 1 required
RESTRolePermission
object
3 properties 3 required
RESTUserRole
object
4 properties 4 required
RESTPwdProfilesData
object
2 properties 2 required
RESTUsersData
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neuvector-user-api-openapi.yml Raw ↑

Other APIs NeuVector publishes across the network.

NeuVector Admission API
NeuVector Apikey API
NeuVector Authentication API
NeuVector Compliance API
NeuVector compliance profile. The payload body is the content of the compliance profile yaml file. API
NeuVector compliance profile. The payload body is the content of the vulnerability profile yaml file. API
NeuVector Container API
NeuVector Controller API
NeuVector DLP API
NeuVector Enforcer API
NeuVector EULA API
NeuVector Federation API