Class ListKeysRequest
Implements
Inherited Members
Namespace: Oci.KeymanagementService.Requests
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class ListKeysRequest : IOciRequest
Examples
Click here to see an example of how to use ListKeys request.
Properties
Algorithm
Declaration
[HttpConverter(TargetEnum.Query, "algorithm")]
public ListKeysRequest.AlgorithmEnum? Algorithm { get; set; }
Property Value
Type | Description |
---|---|
ListKeysRequest.AlgorithmEnum? | The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment. |
Remarks
Required
CurveId
Declaration
[HttpConverter(TargetEnum.Query, "curveId")]
public ListKeysRequest.CurveIdEnum? CurveId { get; set; }
Property Value
Type | Description |
---|---|
ListKeysRequest.CurveIdEnum? | The curve ID of the keys. (This pertains only to ECDSA keys.) |
Length
Declaration
[HttpConverter(TargetEnum.Query, "length")]
public int? Length { get; set; }
Property Value
Type | Description |
---|---|
int? | The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return in a paginated "List" call. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | The value of the |
ProtectionMode
Declaration
[HttpConverter(TargetEnum.Query, "protectionMode")]
public ListKeysRequest.ProtectionModeEnum? ProtectionMode { get; set; }
Property Value
Type | Description |
---|---|
ListKeysRequest.ProtectionModeEnum? | A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A
protection mode of |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListKeysRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListKeysRequest.SortByEnum? | The field to sort by. You can specify only one sort order. The default
order for |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListKeysRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListKeysRequest.SortOrderEnum? | The sort order to use, either ascending ( |