Class BdsApiKeySummary
The API key summary.
Inherited Members
Namespace: Oci.BdsService.Models
Assembly: OCI.DotNetSDK.Bds.dll
Syntax
public class BdsApiKeySummary
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 which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 . |
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(StringEnumConverter))]
public BdsApiKey.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
BdsApiKey.LifecycleStateEnum? | The current status of the API key. |
Remarks
Required
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[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. |
Remarks
Required