# getUserAccess

> Function getUserAccess in pulumi-portainer.

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

Function getUserAccess in pulumi-portainer.

Invoke token: `portainer:index/getUserAccess:getUserAccess`.

## 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 result = await portainer.getUserAccess()
```

`getUserAccessOutput` accepts Input values and returns `Output` of the same result.

## Arguments

| Property | Type     | Required | Description |
| -------- | -------- | -------- | ----------- |
| `id`     | `string` | no       |             |
| `userId` | `number` | no       |             |

## Result

| Property            | Type                             | Always present | Description |
| ------------------- | -------------------------------- | -------------- | ----------- |
| `effectiveAccesses` | `GetUserAccessEffectiveAccess[]` | yes            |             |
| `id`                | `string`                         | yes            |             |
| `memberships`       | `GetUserAccessMembership[]`      | yes            |             |
| `role`              | `number`                         | yes            |             |
| `userId`            | `number`                         | no             |             |
| `username`          | `string`                         | yes            |             |

## `GetUserAccessEffectiveAccess`

Output object `GetUserAccessEffectiveAccess`. Fields below belong to this object.

| Property         | Type     | Always present | Description |
| ---------------- | -------- | -------------- | ----------- |
| `accessLocation` | `string` | no             |             |
| `endpointId`     | `number` | no             |             |
| `endpointName`   | `string` | no             |             |
| `groupId`        | `number` | no             |             |
| `groupName`      | `string` | no             |             |
| `roleId`         | `number` | no             |             |
| `roleName`       | `string` | no             |             |
| `rolePriority`   | `number` | no             |             |
| `teamId`         | `number` | no             |             |
| `teamName`       | `string` | no             |             |

## `GetUserAccessMembership`

Output object `GetUserAccessMembership`. Fields below belong to this object.

| Property | Type     | Always present | Description |
| -------- | -------- | -------------- | ----------- |
| `id`     | `number` | no             |             |
| `role`   | `number` | no             |             |
| `teamId` | `number` | no             |             |