Show / Hide Table of Contents

Class ListCryptoAssessmentKeysRequest

Inheritance
object
ListCryptoAssessmentKeysRequest
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 ListCryptoAssessmentKeysRequest : IOciRequest
Examples

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListCryptoAssessmentKeysRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListCryptoAssessmentKeysRequest.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.

AssessmentId

Declaration
[HttpConverter(TargetEnum.Query, "assessmentId")]
public string AssessmentId { get; set; }
Property Value
Type Description
string

A filter to return only resources associated with the specified crypto assessment OCID.

AssessmentType

Declaration
[HttpConverter(TargetEnum.Query, "assessmentType")]
public CryptoAssessment.TypeEnum? AssessmentType { get; set; }
Property Value
Type Description
CryptoAssessment.TypeEnum?

A filter to return targets from assessments of the specified type.

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.

Feature

Declaration
[HttpConverter(TargetEnum.Query, "feature")]
public CryptoFeature? Feature { get; set; }
Property Value
Type Description
CryptoFeature?

A filter to return only records for the specified feature.

KeyId

Declaration
[HttpConverter(TargetEnum.Query, "keyId")]
public string KeyId { get; set; }
Property Value
Type Description
string

Filters key results to rows with an exact matching keyId.

KeyManagerType

Declaration
[HttpConverter(TargetEnum.Query, "keyManagerType", CollectionFormatType.Multi)]
public List<CryptoKeystoreType> KeyManagerType { get; set; }
Property Value
Type Description
List<CryptoKeystoreType>

Filters key results to rows whose primary or secondary keystore type matches any of the specified key manager types.

KeyType

Declaration
[HttpConverter(TargetEnum.Query, "keyType")]
public CryptoAssessmentKeySummary.KeyTypeEnum? KeyType { get; set; }
Property Value
Type Description
CryptoAssessmentKeySummary.KeyTypeEnum?

Filters key results to rows with the specified key type.

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.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListCryptoAssessmentKeysRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListCryptoAssessmentKeysRequest.SortByEnum?

The field used to sort key results.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListCryptoAssessmentKeysRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListCryptoAssessmentKeysRequest.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 inventory rows associated with the specified target OCID.

TargetIds

Declaration
[HttpConverter(TargetEnum.Query, "targetIds", CollectionFormatType.Multi)]
public List<string> TargetIds { get; set; }
Property Value
Type Description
List<string>

A filter to return only resources associated with any of the specified target OCIDs.

Implements

IOciRequest
In this article
Back to top