java.lang.Object
- org.zaproxy.clientapi.gen.deprecated.UsersDeprecated
- - org.zaproxy.clientapi.gen.Users

public class Users
extends UsersDeprecated

This file was automatically generated.

Constructor Summary

Constructors
Constructor Description

Users(ClientApi api)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ApiResponse`	`authenticateAsUser(java.lang.String contextid, java.lang.String userid)`	Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.
`ApiResponse`	`getAuthenticationCredentials(java.lang.String contextid, java.lang.String userid)`	Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.
`ApiResponse`	`getAuthenticationCredentialsConfigParams(java.lang.String contextid)`	Gets the configuration parameters for the credentials of the context with the given ID.
`ApiResponse`	`getAuthenticationSession(java.lang.String contextid, java.lang.String userid)`	Gets the authentication session information for the user identified by the Context and User Ids, e.g.
`ApiResponse`	`getAuthenticationState(java.lang.String contextid, java.lang.String userid)`	Gets the authentication state information for the user identified by the Context and User Ids.
`ApiResponse`	`getUserById(java.lang.String contextid, java.lang.String userid)`	Gets the data of the user with the given ID that belongs to the context with the given ID.
`ApiResponse`	`newUser(java.lang.String contextid, java.lang.String name)`	Creates a new user with the given name for the context with the given ID.
`ApiResponse`	`pollAsUser(java.lang.String contextid, java.lang.String userid)`	Tries to poll as the identified user, returning the authentication request and whether it appears to have succeeded.
`ApiResponse`	`removeUser(java.lang.String contextid, java.lang.String userid)`	Removes the user with the given ID that belongs to the context with the given ID.
`ApiResponse`	`setAuthenticationCredentials(java.lang.String contextid, java.lang.String userid, java.lang.String authcredentialsconfigparams)`	Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.
`ApiResponse`	`setAuthenticationState(java.lang.String contextid, java.lang.String userid, java.lang.String lastpollresult, java.lang.String lastpolltimeinms, java.lang.String requestssincelastpoll)`	Sets fields in the authentication state for the user identified by the Context and User Ids.
`ApiResponse`	`setCookie(java.lang.String contextid, java.lang.String userid, java.lang.String domain, java.lang.String name, java.lang.String value, java.lang.String path, java.lang.String secure)`	Sets the specified cookie for the user identified by the Context and User Ids.
`ApiResponse`	`setUserEnabled(java.lang.String contextid, java.lang.String userid, java.lang.String enabled)`	Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.
`ApiResponse`	`setUserName(java.lang.String contextid, java.lang.String userid, java.lang.String name)`	Renames the user with the given ID that belongs to the context with the given ID.
`ApiResponse`	`usersList(java.lang.String contextid)`	Gets a list of users that belong to the context with the given ID, or all users if none provided.

Methods inherited from class org.zaproxy.clientapi.gen.deprecated.UsersDeprecated
newUser, removeUser, setAuthenticationCredentials, setUserEnabled, setUserName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Users
```
public Users(ClientApi api)
```

Method Detail

usersList
```
public ApiResponse usersList(java.lang.String contextid)
                      throws ClientApiException
```
Gets a list of users that belong to the context with the given ID, or all users if none provided.

Throws:

ClientApiException

getUserById

public ApiResponse getUserById(java.lang.String contextid,
                               java.lang.String userid)
                        throws ClientApiException

Gets the data of the user with the given ID that belongs to the context with the given ID.

Throws:: ClientApiException

getAuthenticationCredentialsConfigParams

public ApiResponse getAuthenticationCredentialsConfigParams(java.lang.String contextid)
                                                     throws ClientApiException

Gets the configuration parameters for the credentials of the context with the given ID.

Throws:: ClientApiException

getAuthenticationCredentials

public ApiResponse getAuthenticationCredentials(java.lang.String contextid,
                                                java.lang.String userid)
                                         throws ClientApiException

Gets the authentication credentials of the user with given ID that belongs to the context with the given ID.

Throws:: ClientApiException

getAuthenticationState

public ApiResponse getAuthenticationState(java.lang.String contextid,
                                          java.lang.String userid)
                                   throws ClientApiException

Gets the authentication state information for the user identified by the Context and User Ids.

Throws:: ClientApiException

getAuthenticationSession

public ApiResponse getAuthenticationSession(java.lang.String contextid,
                                            java.lang.String userid)
                                     throws ClientApiException

Gets the authentication session information for the user identified by the Context and User Ids, e.g. cookies and realm credentials.

Throws:: ClientApiException

newUser

public ApiResponse newUser(java.lang.String contextid,
                           java.lang.String name)
                    throws ClientApiException

Creates a new user with the given name for the context with the given ID.

Throws:: ClientApiException

removeUser

public ApiResponse removeUser(java.lang.String contextid,
                              java.lang.String userid)
                       throws ClientApiException

Removes the user with the given ID that belongs to the context with the given ID.

Throws:: ClientApiException

setUserEnabled

public ApiResponse setUserEnabled(java.lang.String contextid,
                                  java.lang.String userid,
                                  java.lang.String enabled)
                           throws ClientApiException

Sets whether or not the user, with the given ID that belongs to the context with the given ID, should be enabled.

Throws:: ClientApiException

setUserName

public ApiResponse setUserName(java.lang.String contextid,
                               java.lang.String userid,
                               java.lang.String name)
                        throws ClientApiException

Renames the user with the given ID that belongs to the context with the given ID.

Throws:: ClientApiException

setAuthenticationCredentials

public ApiResponse setAuthenticationCredentials(java.lang.String contextid,
                                                java.lang.String userid,
                                                java.lang.String authcredentialsconfigparams)
                                         throws ClientApiException

Sets the authentication credentials for the user with the given ID that belongs to the context with the given ID.

Throws:: ClientApiException

authenticateAsUser

public ApiResponse authenticateAsUser(java.lang.String contextid,
                                      java.lang.String userid)
                               throws ClientApiException

Tries to authenticate as the identified user, returning the authentication request and whether it appears to have succeeded.

Throws:: ClientApiException

pollAsUser
```
public ApiResponse pollAsUser(java.lang.String contextid,
                              java.lang.String userid)
                       throws ClientApiException
```
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.

Throws:

ClientApiException

setAuthenticationState

public ApiResponse setAuthenticationState(java.lang.String contextid,
                                          java.lang.String userid,
                                          java.lang.String lastpollresult,
                                          java.lang.String lastpolltimeinms,
                                          java.lang.String requestssincelastpoll)
                                   throws ClientApiException

Sets fields in the authentication state for the user identified by the Context and User Ids.

Throws:: ClientApiException

setCookie

public ApiResponse setCookie(java.lang.String contextid,
                             java.lang.String userid,
                             java.lang.String domain,
                             java.lang.String name,
                             java.lang.String value,
                             java.lang.String path,
                             java.lang.String secure)
                      throws ClientApiException

Sets the specified cookie for the user identified by the Context and User Ids.

Throws:: ClientApiException

Class Users

Constructor Summary