Show / Hide Table of Contents

Class Instance

A Public Safety and Security instance.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

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

Properties

AdminIdentityDomainUserId

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

The OCID of the identity-domain user that initially administers the PSS instance.

Remarks

Required

CompartmentId

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

The OCID of the compartment.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

Remarks

Required

DisplayName

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

A user-friendly name. Does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

Remarks

Required

Id

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

The OCID of the Instance.

Remarks

Required

IdentityDomainUrl

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

The URL of the identity domain associated with the instance.
Example: https://idcs-1234567890.identity.oraclecloud.com

Remarks

Required

IdentityDomainWebAuthClientId

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

The client ID of the identity-domain confidential application used for browser authentication.

IdentityDomainWebAuthClientSecretVaultId

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

The OCID of the Vault secret containing the identity-domain confidential application's client secret.

LifecycleDetails

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

A message that describes the current state of the Instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

LifecycleState

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

The current state of the Instance.

Remarks

Required

PublicIp

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

The public IP address for the instance's API gateway.

ServiceEndpoint

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

The HTTPS endpoint for the instance's PSS API.
Example: https://example.pss.oraclecloud.com/api/

SystemTags

Declaration
[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"example-key": "example-value"}}

Remarks

Required

TimeCreated

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

The date and time the Instance was created, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeUpdated

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

The date and time the Instance was updated, in the format defined by RFC 3339.
Example: 2016-08-25T21:10:29.600Z

UiEndpoint

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

The HTTPS endpoint for the instance's PSS user interface.
Example: https://example.pss.oraclecloud.com/ui/

In this article
Back to top