Class ListSecretsRequest

Inheritance

object

ListSecretsRequest

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.VaultService.Requests

Assembly: OCI.DotNetSDK.Vault.dll

Syntax

public class ListSecretsRequest : IOciRequest

Examples

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

Properties

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

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public SecretSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
SecretSummary.LifecycleStateEnum?	A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.

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.

Name

Declaration

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

Property Value

Type	Description
string	The secret name.

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 opc-next-page response header from the previous "List" call.

SortBy

Declaration

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

Property Value

Type	Description
ListSecretsRequest.SortByEnum?	The field to sort by. You can specify only one sort order. The default order for TIMECREATED is descending. The default order for NAME is ascending.

SortOrder

Declaration

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

Property Value

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

VaultId

Declaration

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

Property Value

Type	Description
string	The OCID of the vault.

Implements

IOciRequest