Class BdsApiKey

The API key information.

Inheritance
object
BdsApiKey
Inherited Members
Namespace: Oci.BdsService.Models
Assembly: OCI.DotNetSDK.Bds.dll
Syntax
public class BdsApiKey

Properties

DefaultRegion

Declaration
[Required(ErrorMessage = "DefaultRegion is required.")]
[JsonProperty(PropertyName = "defaultRegion")]
public string DefaultRegion { get; set; }
Property Value
Type Description
string

The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
Remarks

Required

DomainOcid

Declaration
[JsonProperty(PropertyName = "domainOcid")]
public string DomainOcid { get; set; }
Property Value
Type Description
string

Identity domain OCID ,where user is present. For default domain ,this field will be optional.

Fingerprint

Declaration
[Required(ErrorMessage = "Fingerprint is required.")]
[JsonProperty(PropertyName = "fingerprint")]
public string Fingerprint { get; set; }
Property Value
Type Description
string

The fingerprint that corresponds to the public API key requested.
Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Identifier of the user's API key.
Remarks

Required

KeyAlias

Declaration
[Required(ErrorMessage = "KeyAlias is required.")]
[JsonProperty(PropertyName = "keyAlias")]
public string KeyAlias { get; set; }
Property Value
Type Description
string

User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public BdsApiKey.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
BdsApiKey.LifecycleStateEnum?

The state of the key.
Remarks

Required

Pemfilepath

Declaration
[Required(ErrorMessage = "Pemfilepath is required.")]
[JsonProperty(PropertyName = "pemfilepath")]
public string Pemfilepath { get; set; }
Property Value
Type Description
string

The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system.
Remarks

Required

TenantId

Declaration
[Required(ErrorMessage = "TenantId is required.")]
[JsonProperty(PropertyName = "tenantId")]
public string TenantId { get; set; }
Property Value
Type Description
string

The OCID of your tenancy.
Remarks

Required

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The time the API key was created, shown as an RFC 3339 formatted datetime string.

UserId

Declaration
[Required(ErrorMessage = "UserId is required.")]
[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }
Property Value
Type Description
string

The user OCID for which this API key was created.
Remarks

Required