Class ListUsersRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListUsersRequest : IOciRequest
Examples
Click here to see an example of how to use ListUsers request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListUsersRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListUsersRequest.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. |
AccountStatus
Declaration
[HttpConverter(TargetEnum.Query, "accountStatus")]
public string AccountStatus { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified account status. |
AreAllSchemasAccessible
Declaration
[HttpConverter(TargetEnum.Query, "areAllSchemasAccessible")]
public bool? AreAllSchemasAccessible { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to return only items that match the criteria that all schemas can be accessed by a user. |
AuthenticationType
Declaration
[HttpConverter(TargetEnum.Query, "authenticationType")]
public string AuthenticationType { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified authentication type. |
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. |
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. |
SchemaList
Declaration
[HttpConverter(TargetEnum.Query, "schemaList", CollectionFormatType.Multi)]
public List<string> SchemaList { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A filter to return items that contain the specified schema list. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListUsersRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListUsersRequest.SortByEnum? | The field to sort by. You can specify only one sort order (sortOrder). The default order for userName is ascending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListUsersRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListUsersRequest.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. |
TimeLastLoginGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeLastLoginGreaterThanOrEqualTo")]
public DateTime? TimeLastLoginGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose last login time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
|
TimeLastLoginLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeLastLoginLessThan")]
public DateTime? TimeLastLoginLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose last login time in the database is less than the date and time specified, in the format defined by RFC3339. **Example: ** 2016-12-19T16:39:57.600Z |
TimePasswordLastChangedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timePasswordLastChangedGreaterThanOrEqualTo")]
public DateTime? TimePasswordLastChangedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose last password change in the database is greater than or equal to the date and time specified, in the format defined by RFC3339.
|
TimePasswordLastChangedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timePasswordLastChangedLessThan")]
public DateTime? TimePasswordLastChangedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose last password change in the database is less than the date and time specified, in the format defined by RFC3339.
|
TimeUserCreatedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeUserCreatedGreaterThanOrEqualTo")]
public DateTime? TimeUserCreatedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose creation time in the database is greater than or equal to the date and time specified, in the format defined by RFC3339. **Example: ** 2016-12-19T16:39:57.600Z |
TimeUserCreatedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeUserCreatedLessThan")]
public DateTime? TimeUserCreatedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return users whose creation time in the database is less than the date and time specified, in the format defined by RFC3339. **Example: ** 2016-12-19T16:39:57.600Z |
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
UserCategory
Declaration
[HttpConverter(TargetEnum.Query, "userCategory")]
public string UserCategory { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user category. |
UserKey
Declaration
[HttpConverter(TargetEnum.Query, "userKey")]
public string UserKey { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user key. |
UserName
Declaration
[HttpConverter(TargetEnum.Query, "userName")]
public string UserName { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user name. |
UserProfile
Declaration
[HttpConverter(TargetEnum.Query, "userProfile")]
public string UserProfile { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user profile. |
UserRole
Declaration
[HttpConverter(TargetEnum.Query, "userRole")]
public string UserRole { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user role. |
UserType
Declaration
[HttpConverter(TargetEnum.Query, "userType")]
public string UserType { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items that match the specified user type. The possible values can be
|