< Back
Get-OneLoginRole
Post
NAME Get-OneLoginRole
SYNOPSIS
Retrieves roles from a OneLogin account.
SYNTAX
Get-OneLoginRole [<CommonParameters>]
DESCRIPTION
Retrieves roles from a OneLogin account.
PARAMETERS
-Filter <>
You can use the -Filter parameter to search for roles matching values that you specify. A filter should be in
the format of a PowerShell hashtable with one or more properties as keys. Note that the filter values should
always be strings, and can contain asterisks as wildcards. Acceptable properties to filter on are:
- name
- id
To learn more about hashtables, run the following command:
Get-Help about_hash_tables
This parameter cannot be used with -Identity r -All
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-Identity <>
Specifies the numeric id of a OneLogin role.
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-All <>
Specifies tthat you would like to return all roles in your OneLogin account. This parameter cannot be used
with -Filter or -Identity.
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
OneLoginRole
NOTES
---------- -------------- Example 1 -------------- ----------
Get-OneLoginRole -All
This example returns all roles in the OneLogin account.
---------- -------------- Example 2 -------------- ----------
Get-OneLoginRole -Identity 19848683
This example demonstrates how to use the -Identity parameter to return a single role object.
RELATED LINKS
OneLogin roles https://developers.onelogin.com/api-doc ... /get-roles
SYNOPSIS
Retrieves roles from a OneLogin account.
SYNTAX
Get-OneLoginRole [<CommonParameters>]
DESCRIPTION
Retrieves roles from a OneLogin account.
PARAMETERS
-Filter <>
You can use the -Filter parameter to search for roles matching values that you specify. A filter should be in
the format of a PowerShell hashtable with one or more properties as keys. Note that the filter values should
always be strings, and can contain asterisks as wildcards. Acceptable properties to filter on are:
- name
- id
To learn more about hashtables, run the following command:
Get-Help about_hash_tables
This parameter cannot be used with -Identity r -All
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-Identity <>
Specifies the numeric id of a OneLogin role.
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
-All <>
Specifies tthat you would like to return all roles in your OneLogin account. This parameter cannot be used
with -Filter or -Identity.
Required? false
Position? named
Default value None
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
OneLoginRole
NOTES
---------- -------------- Example 1 -------------- ----------
Get-OneLoginRole -All
This example returns all roles in the OneLogin account.
---------- -------------- Example 2 -------------- ----------
Get-OneLoginRole -Identity 19848683
This example demonstrates how to use the -Identity parameter to return a single role object.
RELATED LINKS
OneLogin roles https://developers.onelogin.com/api-doc ... /get-roles