Get-PSURole
SYNOPSIS
Returns the roles defined within PSU.
SYNTAX
All (Default)
Get-PSURole [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>] [-UseDefaultCredentials]
[-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]Name
Get-PSURole [[-Name] <String>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
[-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
[<CommonParameters>]Id
Get-PSURole [[-Id] <Int64>] [-ComputerName <String>] [-AppToken <String>] [-Credential <PSCredential>]
[-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
[<CommonParameters>]DESCRIPTION
Returns the roles defined within PSU. Roles specify what identities are capable of in PSU.
EXAMPLES
Example 1
Returns all roles defined within PSU.
Example 2
Returns the Administrator role.
PARAMETERS
-AppToken
An app token to access the PSU API.
-ComputerName
The HTTP address of the PSU REST API server.
-Id
The ID of the role to return.
-Integrated
Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.
-Name
The name of the role to return.
-UseDefaultCredentials
Use default credentials when connecting to the management API
-Credential
Credentials to login to the PowerShell Universal Management API.
-TrustCertificate
Whether the cmdlet should ignore certificate issues.
-Cookies
Reuses and persists authentication cookies for the current PowerShell session.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.
INPUTS
None
OUTPUTS
System.Object
NOTES
RELATED LINKS
PERMISSIONS
The access token requires security.roles/read to run this cmdlet remotely.
Last updated
Was this helpful?