Class ListRolesRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListRolesRequest : IOciRequest
Examples
Click here to see an example of how to use ListRoles request.
Properties
AuthenticationType
Declaration
[HttpConverter(TargetEnum.Query, "authenticationType")]
public string AuthenticationType { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return roles based on authentication type. |
IsOracleMaintained
Declaration
[HttpConverter(TargetEnum.Query, "isOracleMaintained")]
public bool? IsOracleMaintained { get; set; }
Property Value
Type | Description |
---|---|
bool? | A filter to return roles based on whether they are maintained by oracle or not. |
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. |
RoleName
Declaration
[HttpConverter(TargetEnum.Query, "roleName", CollectionFormatType.Multi)]
public List<string> RoleName { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A filter to return only a specific role based on role name. |
RoleNameContains
Declaration
[HttpConverter(TargetEnum.Query, "roleNameContains")]
public string RoleNameContains { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items if role name contains a specific string. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListRolesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListRolesRequest.SortByEnum? | The field used for sorting. Only one sorting order (sortOrder) can be specified. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListRolesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListRolesRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
TargetDatabaseId
Declaration
[Required(ErrorMessage = "TargetDatabaseId is required.")]
[HttpConverter(TargetEnum.Path, "targetDatabaseId")]
public string TargetDatabaseId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Data Safe target database. |
Remarks
Required