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

OWASP ZAP users API

The users API from OWASP ZAP — 15 operation(s) for users.

OWASP ZAP users API is one of 49 APIs that OWASP ZAP 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, and a GitHub repository.

This API exposes 15 operations across 15 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 2.16.1.

Requests are made against 2 base URLs: http://zap, http://{address}:{port}.

15 operations 15 paths 1 schemas 15 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.16.1
Base URL
http://zap
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

OWASP ZAP users API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-ZAP-API-Key (apiKeyHeader). An API key is passed in the query as apikey (apiKeyQuery). By default, every request must be authenticated, though some operations may also be called without credentials.

Paths & Operations 15

Across 15 paths, the API surfaces 15 operations — 15 GET. Each is listed below with its method, path, parameters, and response codes.

users 15
GET
/JSON/users/action/authenticateAsUser/
Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.
usersActionAuthenticateAsUser 2 params → default
GET
/JSON/users/action/newUser/
Creates a new user with the given name for the context with the given ID.
usersActionNewUser 2 params → default
GET
/JSON/users/action/pollAsUser/
Tries to poll as the identified user, returning the authentication request and whether it appears to have succeeded. This will only work if the polling verification strategy has been configured.
usersActionPollAsUser 2 params → default
GET
/JSON/users/action/removeUser/
Removes the user with the given ID that belongs to the context with the given ID.
usersActionRemoveUser 2 params → default
GET
/JSON/users/action/setAuthenticationCredentials/
Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
usersActionSetAuthenticationCredentials 3 params → default
GET
/JSON/users/action/setAuthenticationState/
Sets fields in the authentication state for the user identified by the Context and User Ids.
usersActionSetAuthenticationState 5 params → default
GET
/JSON/users/action/setCookie/
Sets the specified cookie for the user identified by the Context and User Ids.
usersActionSetCookie 7 params → default
GET
/JSON/users/action/setUserEnabled/
Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
usersActionSetUserEnabled 3 params → default
GET
/JSON/users/action/setUserName/
Renames the user with the given ID that belongs to the context with the given ID.
usersActionSetUserName 3 params → default
GET
/JSON/users/view/getAuthenticationCredentials/
Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
usersViewGetAuthenticationCredentials 2 params → default
GET
/JSON/users/view/getAuthenticationCredentialsConfigParams/
Gets the configuration parameters for the credentials of the context with the given ID.
usersViewGetAuthenticationCredentialsConfigParams 1 param → default
GET
/JSON/users/view/getAuthenticationSession/
Gets the authentication session information for the user identified by the Context and User Ids, e.g. cookies and realm credentials.
usersViewGetAuthenticationSession 2 params → default
GET
/JSON/users/view/getAuthenticationState/
Gets the authentication state information for the user identified by the Context and User Ids.
usersViewGetAuthenticationState 2 params → default
GET
/JSON/users/view/getUserById/
Gets the data of the user with the given ID that belongs to the context with the given ID.
usersViewGetUserById 2 params → default
GET
/JSON/users/view/usersList/
Gets a list of users that belong to the context with the given ID, or all users if none provided.
usersViewUsersList 1 param → default

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is ErrorJson (3 properties). Each schema is shown below with its type and property counts.

ErrorJson
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

owasp-zap-users-api-openapi.yml Raw ↑

Other APIs OWASP ZAP publishes across the network.

OWASP ZAP accessControl API
OWASP ZAP acsrf API
OWASP ZAP ajaxSpider API
OWASP ZAP alert API
OWASP ZAP alertFilter API
OWASP ZAP ascan API
OWASP ZAP authentication API
OWASP ZAP authorization API
OWASP ZAP automation API
OWASP ZAP autoupdate API
OWASP ZAP break API
OWASP ZAP client API
Where this information came from

This is an independent, third-party profile of OWASP ZAP users 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.