Get-OCIIdentityUserGroupMembershipsList
SYNOPSIS
Invokes Identity service - ListUserGroupMemberships operation.
SYNTAX
Limit
Get-OCIIdentityUserGroupMembershipsList -CompartmentId <String> [-UserId <String>] [-GroupId <String>] [-Page <String>] [-Limit <Int32>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
AllPages
Get-OCIIdentityUserGroupMembershipsList -CompartmentId <String> [-UserId <String>] [-GroupId <String>] [-Page <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
DESCRIPTION
Lists the UserGroupMembership objects in your tenancy. You must specify your tenancy's OCID as the value for the compartment ID (see Where to Get the Tenancy's OCID and User's OCID). You must also then filter the list in one of these ways: - You can limit the results to just the memberships for a given user by specifying a userId. - Similarly, you can limit the results to just the memberships for a given group by specifying a groupId. - You can set both the userId and groupId to determine if the specified user is in the specified group. If the answer is no, the response is an empty list. - AlthoughuserId and groupId are not individually required, you must set one of them.
PARAMETERS
-All
Fetches all pages of results.
Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AuthType
Type of authentication to use for making API requests. Default is Key based Authentication.
Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompartmentId
The OCID of the compartment (remember that the tenancy is simply the root compartment).
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConfigFile
The path to the config file.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Endpoint
The value to use as the service endpoint, including any required API version path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FullResponse
Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-GroupId
The OCID of the group.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Limit
The maximum number of items to return in a paginated "List" call.
Type: Int32
Parameter Sets: Limit
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NoRetry
Disable retry logic for calls to services.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Page
The value of the `opc-next-page` response header from the previous "List" call.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Profile
The profile in the config file to load.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TimeOutInMillis
Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).
Type: Int32
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserId
The OCID of the user.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.
OUTPUTS
- Oci.IdentityService.Models.UserGroupMembership
- Oci.IdentityService.Responses.ListUserGroupMembershipsResponse