> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IUser

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/user/index.ts

Represents platform user.

**Signature:**

```typescript
export interface IUser 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [authenticationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserauthenticationid) |  | string | _(Optional)_ Authentication id of the user. |
| [deployment?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserdeployment) |  | string | _(Optional)_ In which deployment the user was requested |
| [email?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuseremail) |  | string | _(Optional)_ Contact email of the user. |
| [entitlements?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserentitlements) |  | [IEntitlementDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ientitlementdescriptor/index.md)[] | _(Optional)_ Entitlements for the user. |
| [firstName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserfirstname) |  | string | _(Optional)_ First name - when backend implementations supports it. |
| [fullName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserfullname) |  | string | _(Optional)_ Full name. Note: This property has higher priority than firstName / lastName. Backend implementation MUST fill this property if user names are supported. |
| [lastName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserlastname) |  | string | _(Optional)_ Last name - when backend implementations supports it. |
| [login](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserlogin) |  | string | Login - unique user ID for logging into the platform. |
| [organizationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserorganizationid) |  | string | _(Optional)_ Organization id - when backend implementations supports it. |
| [organizationName?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserorganizationname) |  | string | _(Optional)_ Organization name - when backend implementations supports it. |
| [permissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserpermissions) |  | string[] | _(Optional)_ Permission of the user |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iuserref) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | Stored user reference. |
| [systemAccount?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iuser/index.md#iusersystemaccount) |  | boolean | _(Optional)_ When true, the user is marked as a system account. |

## Property details

### IUser.authenticationId

Authentication id of the user.

**Signature:**

```typescript
authenticationId?: string;
```

### IUser.deployment

In which deployment the user was requested

**Signature:**

```typescript
deployment?: string;
```

### IUser.email

Contact email of the user.

**Signature:**

```typescript
email?: string;
```

### IUser.entitlements

Entitlements for the user.

**Signature:**

```typescript
entitlements?: IEntitlementDescriptor[];
```

### IUser.firstName

First name - when backend implementations supports it.

**Signature:**

```typescript
firstName?: string;
```

### IUser.fullName

Full name.

Note: This property has higher priority than firstName / lastName. Backend implementation MUST fill this property if user names are supported.

**Signature:**

```typescript
fullName?: string;
```

### IUser.lastName

Last name - when backend implementations supports it.

**Signature:**

```typescript
lastName?: string;
```

### IUser.login

Login - unique user ID for logging into the platform.

**Signature:**

```typescript
login: string;
```

### IUser.organizationId

Organization id - when backend implementations supports it.

**Signature:**

```typescript
organizationId?: string;
```

### IUser.organizationName

Organization name - when backend implementations supports it.

**Signature:**

```typescript
organizationName?: string;
```

### IUser.permissions

Permission of the user

**Signature:**

```typescript
permissions?: string[];
```

### IUser.ref

Stored user reference.

**Signature:**

```typescript
ref: ObjRef;
```

### IUser.systemAccount

When true, the user is marked as a system account.

**Signature:**

```typescript
systemAccount?: boolean;
```
