> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubeffectiveaccess.md).

# Get-RASPubEffectiveAccess

## SYNOPSIS

Retrieves effective access about one user.

## SYNTAX

```powershell
Get-RASPubEffectiveAccess
 -ClientDeviceOS {Windows | Linux | macOS | Android | iOS | WebClient | Wyse | Any}
 -Username <string> [-ClientDeviceName <string>] [-GatewayIP <string>] [-HardwareID <string>]
 [-PrivateIPAddress <string>] [-SiteId <uint>] [-ThemeId <uint>]
 [-Type {All | PublishedResource | FileAccess}] [<CommonParameters>]
```

## DESCRIPTION

Retrieves effective access about one user.

## EXAMPLES

### Example 1

```powershell
Get-RASPubEffectiveAccess
```

Retrieves effective access about one user.

## PARAMETERS

### -SiteId

Site ID.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Type

Published Effective Access Type.

Possible values: All, PublishedResource, FileAccess

Type reference: [PubEffectiveAccessType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubeffectiveaccesstype.md)

```yaml
Type: PubEffectiveAccessType
Required: False
Position: Named
Default value: PublishedResource
Accept pipeline input: False
Accept wildcard characters: False
```

### -Username

Username.

```yaml
Type: string
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClientDeviceName

Client device name.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ClientDeviceOS

Client device OS.

Possible values: Windows, Linux, macOS, Android, iOS, WebClient, Wyse, Any

Type reference: [ClientTypes](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/clienttypes.md)

```yaml
Type: ClientTypes
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -PrivateIPAddress

Private IP address.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -HardwareID

Hardware Id.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -GatewayIP

Secure Gateway IP.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ThemeId

Theme Id.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### [PubEffectiveAccess](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/pubeffectiveaccess.md)

## RELATED LINKS

* [Get-RASPubItem](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubitem.md)
* [Set-RASPubItem](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-raspubitem.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubeffectiveaccess.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
