Get-OCIDatasafeProfileSummariesList

SYNOPSIS

Invokes DataSafe service - ListProfileSummaries operation.

SYNTAX

Limit

Get-OCIDatasafeProfileSummariesList -UserAssessmentId <String> -CompartmentId <String> [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-TargetId <String>] [-Limit <Int32>] [-Page <String>] [-ProfileName <String>] [-IsUserCreated <Boolean>] [-PasswordVerificationFunction <String>] [-UserCountGreaterThanOrEqual <String>] [-UserCountLessThan <String>] [-FailedLoginAttemptsGreaterThanOrEqual <String>] [-FailedLoginAttemptsLessThan <String>] [-SessionsPerUserGreaterThanOrEqual <String>] [-SessionsPerUserLessThan <String>] [-InactiveAccountTimeGreaterThanOrEqual <String>] [-InactiveAccountTimeLessThan <String>] [-PasswordLockTimeGreaterThanOrEqual <String>] [-PasswordLockTimeLessThan <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-OpcRequestId <String>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

AllPages

Get-OCIDatasafeProfileSummariesList -UserAssessmentId <String> -CompartmentId <String> [-CompartmentIdInSubtree <Boolean>] [-AccessLevel <AccessLevelEnum>] [-TargetId <String>] [-Page <String>] [-ProfileName <String>] [-IsUserCreated <Boolean>] [-PasswordVerificationFunction <String>] [-UserCountGreaterThanOrEqual <String>] [-UserCountLessThan <String>] [-FailedLoginAttemptsGreaterThanOrEqual <String>] [-FailedLoginAttemptsLessThan <String>] [-SessionsPerUserGreaterThanOrEqual <String>] [-SessionsPerUserLessThan <String>] [-InactiveAccountTimeGreaterThanOrEqual <String>] [-InactiveAccountTimeLessThan <String>] [-PasswordLockTimeGreaterThanOrEqual <String>] [-PasswordLockTimeLessThan <String>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-OpcRequestId <String>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]

DESCRIPTION

Gets a list of user profiles containing the profile details along with the target id and user counts. The ListProfiles operation returns only the profiles belonging to a certain target. If compartment type user assessment id is provided, then profile information for all the targets belonging to the pertaining compartment is returned. The list does not include any subcompartments of the compartment under consideration. The parameter 'accessLevel' specifies whether to return only those compartments for which the requestor has INSPECT permissions on at least one resource directly or indirectly (ACCESSIBLE) (the resource can be in a subcompartment) or to return Not Authorized if Principal doesn't have access to even one of the child compartments. This is valid only when 'compartmentIdInSubtree' is set to 'true'. The parameter 'compartmentIdInSubtree' applies when you perform ListUserProfiles on the 'compartmentId' belonging to the assessmentId passed and when it is set to true, the entire hierarchy of compartments can be returned. To get a full list of all compartments and subcompartments in the tenancy (root compartment), set the parameter 'compartmentIdInSubtree' to true and 'accessLevel' to ACCESSIBLE.

PARAMETERS

-AccessLevel

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

Type: AccessLevelEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Restricted, Accessible

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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

A filter to return only resources that match the specified compartment OCID.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CompartmentIdInSubtree

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
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

-FailedLoginAttemptsGreaterThanOrEqual

An optional filter to return the profiles having allow failed login attempts number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-FailedLoginAttemptsLessThan

An optional filter to return the profiles having failed login attempts number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

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

-InactiveAccountTimeGreaterThanOrEqual

An optional filter to return the profiles allowing inactive account time in days greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InactiveAccountTimeLessThan

An optional filter to return the profiles allowing inactive account time in days less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IsUserCreated

An optional filter to return the user created profiles.

Type: Boolean
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Limit

For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

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

-OpcRequestId

Unique identifier for the request.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Page

For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PasswordLockTimeGreaterThanOrEqual

An optional filter to return the profiles having password lock number greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PasswordLockTimeLessThan

An optional filter to return the profiles having password lock number less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PasswordVerificationFunction

An optional filter to filter the profiles based on password verification function.

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

-ProfileName

A filter to return only items that match the specified profile name.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-SessionsPerUserGreaterThanOrEqual

An optional filter to return the profiles permitting the user to spawn multiple sessions having count. greater than or equal to the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SessionsPerUserLessThan

An optional filter to return the profiles permitting the user to spawn multiple sessions having count less than the provided value. String value is used for accommodating the "UNLIMITED" and "DEFAULT" values.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortBy

The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC.

Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: ProfileName, TargetId, IsUserCreated, PasswordVerificationFunction, UserCount, SessionsPerUser, InactiveAccountTime, PasswordLockTime, FailedLoginAttempts

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-SortOrder

The sort order to use, either ascending (ASC) or descending (DESC).

Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-TargetId

A filter to return only items related to a specific target OCID.

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

-UserAssessmentId

The OCID of the user assessment.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserCountGreaterThanOrEqual

An optional filter to return the profiles having user count greater than or equal to the provided value.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-UserCountLessThan

An optional filter to return the profiles having user count less than the provided value.

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.DatasafeService.Models.ProfileSummary
• Oci.DatasafeService.Responses.ListProfileSummariesResponse

RELATED LINKS

• APIReference
• DotnetSDKAPI
• OCIModulesDocs
• OCIServiceConcepts
• Examples