org.everit.atlassian.restclient.jiracloud.v3.model

Class User

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.model.User

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-11-13T15:26:43.813+01:00[Europe/Prague]")
public class User
extends Object

A user with details as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank). * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values. * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.AccountTypeEnum The user account type.

Constructor Summary

Constructors

Constructor and Description
User()

Method Summary

Modifier and Type	Method and Description
User	accountId(String accountId)
boolean	equals(Object o)
String	getAccountId() The account ID of the user, which uniquely identifies the user across all Atlassian products.
User.AccountTypeEnum	getAccountType() The user account type.
Boolean	getActive() Whether the user is active.
SimpleListWrapperApplicationRole	getApplicationRoles() The application roles the user is assigned to.
AvatarUrlsBean	getAvatarUrls() The avatars of the user.
String	getDisplayName() The display name of the user.
String	getEmailAddress() The email address of the user.
String	getExpand() Expand options that include additional user details in the response.
SimpleListWrapperGroupName	getGroups() The groups that the user belongs to.
String	getKey() This property is no longer available and will be removed from the documentation soon.
String	getLocale() The locale of the user.
String	getName() This property is no longer available and will be removed from the documentation soon.
URI	getSelf() The URL of the user.
String	getTimeZone() The time zone specified in the user's profile.
int	hashCode()
User	key(String key)
User	name(String name)
void	setAccountId(String accountId)
void	setKey(String key)
void	setName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User()

Method Detail

accountId

public User accountId(String accountId)

getAccountId

public String getAccountId()

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

getAccountType

public User.AccountTypeEnum getAccountType()

The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk

Returns:

accountType

getActive

public Boolean getActive()

Whether the user is active.

Returns:

active

getApplicationRoles

public SimpleListWrapperApplicationRole getApplicationRoles()

The application roles the user is assigned to.

Returns:

applicationRoles

getAvatarUrls

public AvatarUrlsBean getAvatarUrls()

The avatars of the user.

Returns:

avatarUrls

getDisplayName

public String getDisplayName()

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

Returns:

displayName

getEmailAddress

public String getEmailAddress()

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

Returns:

emailAddress

getExpand

public String getExpand()

Expand options that include additional user details in the response.

Returns:

expand

getGroups

public SimpleListWrapperGroupName getGroups()

The groups that the user belongs to.

Returns:

groups

key

public User key(String key)

getKey

public String getKey()

This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

key

setKey

public void setKey(String key)

getLocale

public String getLocale()

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

Returns:

locale

name

public User name(String name)

getName

public String getName()

This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.

Returns:

name

setName

public void setName(String name)

getSelf

public URI getSelf()

The URL of the user.

Returns:

self

getTimeZone

public String getTimeZone()

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

Returns:

timeZone

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