ZAP API UI

Component: users

Views

getAuthenticationCredentials (contextId* userId* ) Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
getAuthenticationCredentialsConfigParams (contextId* ) Gets the configuration parameters for the credentials of the context with the given ID.
getAuthenticationSession (contextId* userId* ) Gets the authentication session information for the user identified by the Context and User Ids, e.g. cookies and realm credentials.
getAuthenticationState (contextId* userId* ) Gets the authentication state information for the user identified by the Context and User Ids.
getUserById (contextId* userId* ) Gets the data of the user with the given ID that belongs to the context with the given ID.
usersList (contextId ) Gets a list of users that belong to the context with the given ID, or all users if none provided.

Actions

authenticateAsUser (contextId* userId* ) Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.
newUser (contextId* name* ) Creates a new user with the given name for the context with the given ID.
pollAsUser (contextId* userId* ) 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.
removeUser (contextId* userId* ) Removes the user with the given ID that belongs to the context with the given ID.
setAuthenticationCredentials (contextId* userId* authCredentialsConfigParams ) Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
setAuthenticationState (contextId* userId* lastPollResult lastPollTimeInMs requestsSinceLastPoll ) Sets fields in the authentication state for the user identified by the Context and User Ids.
setCookie (contextId* userId* domain* name* value* path secure ) Sets the specified cookie for the user identified by the Context and User Ids.
setUserEnabled (contextId* userId* enabled* ) Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
setUserName (contextId* userId* name* ) Renames the user with the given ID that belongs to the context with the given ID.