Show / Hide Table of Contents

Class CreateBdsApiKeyDetails

API key created on user's behalf.

Inheritance
object
CreateBdsApiKeyDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.BdsService.Models
Assembly: OCI.DotNetSDK.Bds.dll
Syntax
public class CreateBdsApiKeyDetails

Properties

DefaultRegion

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

The name of the region to establish the Object Storage endpoint. See https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/Region/ for additional information.

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.

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 associated with this Big Data Service cluster. Only ASCII alphanumeric characters with no spaces allowed.

Remarks

Required

Passphrase

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

Base64 passphrase used to secure the private key which will be created on user behalf.

Remarks

Required

UserId

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

The OCID of the user for whom this new generated API key pair will be created.

Remarks

Required

In this article
Back to top