Class ListProfileSummariesRequest

Inheritance

object

ListProfileSummariesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Requests

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ListProfileSummariesRequest : IOciRequest

Examples

Click here to see an example of how to use ListProfileSummaries request.

Properties

AccessLevel

Declaration

[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListProfileSummariesRequest.AccessLevelEnum? AccessLevel { get; set; }

Property Value

Type	Description
ListProfileSummariesRequest.AccessLevelEnum?	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.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

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

Remarks

Required

CompartmentIdInSubtree

Declaration

[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	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.

FailedLoginAttemptsGreaterThanOrEqual

Declaration

[HttpConverter(TargetEnum.Query, "failedLoginAttemptsGreaterThanOrEqual")]
public string FailedLoginAttemptsGreaterThanOrEqual { get; set; }

Property Value

Type	Description
string	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.

FailedLoginAttemptsLessThan

Declaration

[HttpConverter(TargetEnum.Query, "failedLoginAttemptsLessThan")]
public string FailedLoginAttemptsLessThan { get; set; }

Property Value

Type	Description
string	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.

InactiveAccountTimeGreaterThanOrEqual

Declaration

[HttpConverter(TargetEnum.Query, "inactiveAccountTimeGreaterThanOrEqual")]
public string InactiveAccountTimeGreaterThanOrEqual { get; set; }

Property Value

Type	Description
string	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.

InactiveAccountTimeLessThan

Declaration

[HttpConverter(TargetEnum.Query, "inactiveAccountTimeLessThan")]
public string InactiveAccountTimeLessThan { get; set; }

Property Value

Type	Description
string	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.

IsUserCreated

Declaration

[HttpConverter(TargetEnum.Query, "isUserCreated")]
public bool? IsUserCreated { get; set; }

Property Value

Type	Description
bool?	An optional filter to return the user created profiles.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	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.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	Unique identifier for the request.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	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.

PasswordLockTimeGreaterThanOrEqual

Declaration

[HttpConverter(TargetEnum.Query, "passwordLockTimeGreaterThanOrEqual")]
public string PasswordLockTimeGreaterThanOrEqual { get; set; }

Property Value

Type	Description
string	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.

PasswordLockTimeLessThan

Declaration

[HttpConverter(TargetEnum.Query, "passwordLockTimeLessThan")]
public string PasswordLockTimeLessThan { get; set; }

Property Value

Type	Description
string	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.

PasswordVerificationFunction

Declaration

[HttpConverter(TargetEnum.Query, "passwordVerificationFunction")]
public string PasswordVerificationFunction { get; set; }

Property Value

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

ProfileName

Declaration

[HttpConverter(TargetEnum.Query, "profileName")]
public string ProfileName { get; set; }

Property Value

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

SessionsPerUserGreaterThanOrEqual

Declaration

[HttpConverter(TargetEnum.Query, "sessionsPerUserGreaterThanOrEqual")]
public string SessionsPerUserGreaterThanOrEqual { get; set; }

Property Value

Type	Description
string	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.

SessionsPerUserLessThan

Declaration

[HttpConverter(TargetEnum.Query, "sessionsPerUserLessThan")]
public string SessionsPerUserLessThan { get; set; }

Property Value

Type	Description
string	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.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListProfileSummariesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListProfileSummariesRequest.SortByEnum?	The field to sort by. You can specify only one sort order (sortOrder). The default order is targetId ASC.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListProfileSummariesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListProfileSummariesRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

TargetId

Declaration

[HttpConverter(TargetEnum.Query, "targetId")]
public string TargetId { get; set; }

Property Value

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

UserAssessmentId

Declaration

[Required(ErrorMessage = "UserAssessmentId is required.")]
[HttpConverter(TargetEnum.Path, "userAssessmentId")]
public string UserAssessmentId { get; set; }

Property Value

Type	Description
string	The OCID of the user assessment.

Remarks

Required

UserCountGreaterThanOrEqual

Declaration

[HttpConverter(TargetEnum.Query, "userCountGreaterThanOrEqual")]
public string UserCountGreaterThanOrEqual { get; set; }

Property Value

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

UserCountLessThan

Declaration

[HttpConverter(TargetEnum.Query, "userCountLessThan")]
public string UserCountLessThan { get; set; }

Property Value

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

Implements

IOciRequest