# User

> Resource User in pulumi-portainer.

<!-- Generated from the pulumi-portainer SDK. -->

Resource User in pulumi-portainer.

Pulumi type: `portainer:index/user:User`.

`name` is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.

## Example

Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.

```ts
import * as portainer from "pulumi-portainer"

const resource = new portainer.User("user", {
  username: "<username>",
})
```

## Arguments

| Property            | Type      | Required | Description                                                                                                                                  |
| ------------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiKeyDescription` | `string`  | no       | Description applied to the generated Portainer API key. Only used when `generateApiKey` is true.                                             |
| `generateApiKey`    | `boolean` | no       | Whether to generate a Portainer API key for the user during creation. Requires password to be set.                                           |
| `ldapUser`          | `boolean` | no       | Whether the user is authenticated via LDAP. When true, password must be empty and authentication is delegated to the configured LDAP server. |
| `password`          | `string`  | no       | Password for the Portainer user. Required for non-LDAP users; must be omitted for LDAP users. Stored in state as a sensitive value.          |
| `role`              | `number`  | no       | Portainer role of the user: 1 = administrator, 2 = standard user. Defaults to 2.                                                             |
| `teamId`            | `number`  | no       | Optional Portainer team ID. Only applicable for standard users (role = 2).                                                                   |
| `userId`            | `string`  | no       |                                                                                                                                              |
| `username`          | `string`  | yes      | Username used to log in to Portainer. Must be unique within the Portainer instance.                                                          |

## Outputs

Computed outputs are produced by the provider. They are not constructor arguments.

| Property            | Type      | Computed | Description                                                                                                                                  |
| ------------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiKeyDescription` | `string`  | no       | Description applied to the generated Portainer API key. Only used when `generateApiKey` is true.                                             |
| `apiKeyRaw`         | `string`  | yes      | Raw API key generated by Portainer when `generateApiKey` is true. Computed and only available after initial creation.                        |
| `generateApiKey`    | `boolean` | no       | Whether to generate a Portainer API key for the user during creation. Requires password to be set.                                           |
| `ldapUser`          | `boolean` | no       | Whether the user is authenticated via LDAP. When true, password must be empty and authentication is delegated to the configured LDAP server. |
| `password`          | `string`  | no       | Password for the Portainer user. Required for non-LDAP users; must be omitted for LDAP users. Stored in state as a sensitive value.          |
| `role`              | `number`  | no       | Portainer role of the user: 1 = administrator, 2 = standard user. Defaults to 2.                                                             |
| `teamId`            | `number`  | no       | Optional Portainer team ID. Only applicable for standard users (role = 2).                                                                   |
| `userId`            | `string`  | no       |                                                                                                                                              |
| `username`          | `string`  | no       | Username used to log in to Portainer. Must be unique within the Portainer instance.                                                          |