Package io.camunda.client.protocol.rest

Class CamundaUserResult

java.lang.Object

io.camunda.client.protocol.rest.CamundaUserResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class CamundaUserResult
extends Object

CamundaUserResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_API_USER
static final String	JSON_PROPERTY_AUTHORIZED_COMPONENTS
static final String	JSON_PROPERTY_C8_LINKS
static final String	JSON_PROPERTY_CAN_LOGOUT
static final String	JSON_PROPERTY_DISPLAY_NAME
static final String	JSON_PROPERTY_EMAIL
static final String	JSON_PROPERTY_GROUPS
static final String	JSON_PROPERTY_ROLES
static final String	JSON_PROPERTY_SALES_PLAN_TYPE
static final String	JSON_PROPERTY_TENANTS
static final String	JSON_PROPERTY_USERNAME

Constructor Summary

Constructors

Constructor	Description
CamundaUserResult()

Method Summary

Modifier and Type	Method	Description
CamundaUserResult	addAuthorizedComponentsItem(String authorizedComponentsItem)
CamundaUserResult	addGroupsItem(String groupsItem)
CamundaUserResult	addRolesItem(String rolesItem)
CamundaUserResult	addTenantsItem(TenantResult tenantsItem)
CamundaUserResult	apiUser(Boolean apiUser)
CamundaUserResult	authorizedComponents(List<String> authorizedComponents)
CamundaUserResult	c8Links(Map<String,String> c8Links)
CamundaUserResult	canLogout(Boolean canLogout)
CamundaUserResult	displayName(String displayName)
CamundaUserResult	email(String email)
boolean	equals(Object o)
Boolean	getApiUser()	Flag for understanding if the user is an API user.
List<String>	getAuthorizedComponents()	The web components the user is authorized to use.
Map<String,String>	getC8Links()	The links to the components in the C8 stack.
Boolean	getCanLogout()	Flag for understanding if the user is able to perform logout.
String	getDisplayName()	The display name of the user.
String	getEmail()	The email of the user.
List<String>	getGroups()	The groups assigned to the user.
List<String>	getRoles()	The roles assigned to the user.
String	getSalesPlanType()	The plan of the user.
List<TenantResult>	getTenants()	The tenants the user is a member of.
String	getUsername()	The username of the user.
CamundaUserResult	groups(List<String> groups)
int	hashCode()
CamundaUserResult	putC8LinksItem(String key, String c8LinksItem)
CamundaUserResult	roles(List<String> roles)
CamundaUserResult	salesPlanType(String salesPlanType)
void	setApiUser(Boolean apiUser)
void	setAuthorizedComponents(List<String> authorizedComponents)
void	setC8Links(Map<String,String> c8Links)
void	setCanLogout(Boolean canLogout)
void	setDisplayName(String displayName)
void	setEmail(String email)
void	setGroups(List<String> groups)
void	setRoles(List<String> roles)
void	setSalesPlanType(String salesPlanType)
void	setTenants(List<TenantResult> tenants)
void	setUsername(String username)
CamundaUserResult	tenants(List<TenantResult> tenants)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
CamundaUserResult	username(String username)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_USERNAME

public static final String JSON_PROPERTY_USERNAME

See Also:

• Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_EMAIL

public static final String JSON_PROPERTY_EMAIL

See Also:

• Constant Field Values

JSON_PROPERTY_AUTHORIZED_COMPONENTS

public static final String JSON_PROPERTY_AUTHORIZED_COMPONENTS

See Also:

• Constant Field Values

JSON_PROPERTY_TENANTS

public static final String JSON_PROPERTY_TENANTS

See Also:

• Constant Field Values

JSON_PROPERTY_GROUPS

public static final String JSON_PROPERTY_GROUPS

See Also:

• Constant Field Values

JSON_PROPERTY_ROLES

public static final String JSON_PROPERTY_ROLES

See Also:

• Constant Field Values

JSON_PROPERTY_SALES_PLAN_TYPE

public static final String JSON_PROPERTY_SALES_PLAN_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_C8_LINKS

public static final String JSON_PROPERTY_C8_LINKS

See Also:

• Constant Field Values

JSON_PROPERTY_CAN_LOGOUT

public static final String JSON_PROPERTY_CAN_LOGOUT

See Also:

• Constant Field Values

JSON_PROPERTY_API_USER

public static final String JSON_PROPERTY_API_USER

See Also:

• Constant Field Values

Constructor Details

CamundaUserResult

public CamundaUserResult()

Method Details

username

public CamundaUserResult username(@Nullable
 String username)

getUsername

@Nullable
public String getUsername()

The username of the user.

Returns:

username

setUsername

public void setUsername(@Nullable
 String username)

displayName

public CamundaUserResult displayName(@Nullable
 String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name of the user.

Returns:

displayName

setDisplayName

public void setDisplayName(@Nullable
 String displayName)

email

public CamundaUserResult email(@Nullable
 String email)

getEmail

@Nullable
public String getEmail()

The email of the user.

Returns:

email

setEmail

public void setEmail(@Nullable
 String email)

authorizedComponents

public CamundaUserResult authorizedComponents(@Nullable
 List<String> authorizedComponents)

addAuthorizedComponentsItem

public CamundaUserResult addAuthorizedComponentsItem(String authorizedComponentsItem)

getAuthorizedComponents

@Nullable
public List<String> getAuthorizedComponents()

The web components the user is authorized to use.

Returns:

authorizedComponents

setAuthorizedComponents

public void setAuthorizedComponents(@Nullable
 List<String> authorizedComponents)

tenants

public CamundaUserResult tenants(@Nullable
 List<TenantResult> tenants)

addTenantsItem

public CamundaUserResult addTenantsItem(TenantResult tenantsItem)

getTenants

@Nullable
public List<TenantResult> getTenants()

The tenants the user is a member of.

Returns:

tenants

setTenants

public void setTenants(@Nullable
 List<TenantResult> tenants)

groups

public CamundaUserResult groups(@Nullable
 List<String> groups)

addGroupsItem

public CamundaUserResult addGroupsItem(String groupsItem)

getGroups

@Nullable
public List<String> getGroups()

The groups assigned to the user.

Returns:

groups

setGroups

public void setGroups(@Nullable
 List<String> groups)

roles

public CamundaUserResult roles(@Nullable
 List<String> roles)

addRolesItem

public CamundaUserResult addRolesItem(String rolesItem)

getRoles

@Nullable
public List<String> getRoles()

The roles assigned to the user.

Returns:

roles

setRoles

public void setRoles(@Nullable
 List<String> roles)

salesPlanType

public CamundaUserResult salesPlanType(@Nullable
 String salesPlanType)

getSalesPlanType

@Nullable
public String getSalesPlanType()

The plan of the user.

Returns:

salesPlanType

setSalesPlanType

public void setSalesPlanType(@Nullable
 String salesPlanType)

c8Links

public CamundaUserResult c8Links(@Nullable
 Map<String,String> c8Links)

putC8LinksItem

public CamundaUserResult putC8LinksItem(String key,
 String c8LinksItem)

getC8Links

@Nullable
public Map<String,String> getC8Links()

The links to the components in the C8 stack.

Returns:

c8Links

setC8Links

public void setC8Links(@Nullable
 Map<String,String> c8Links)

canLogout

public CamundaUserResult canLogout(@Nullable
 Boolean canLogout)

getCanLogout

@Nullable
public Boolean getCanLogout()

Flag for understanding if the user is able to perform logout.

Returns:

canLogout

setCanLogout

public void setCanLogout(@Nullable
 Boolean canLogout)

apiUser

public CamundaUserResult apiUser(@Nullable
 Boolean apiUser)

getApiUser

@Nullable
public Boolean getApiUser()

Flag for understanding if the user is an API user.

Returns:

apiUser

setApiUser

public void setApiUser(@Nullable
 Boolean apiUser)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string