Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Session

A bastion session resource. A bastion session lets authorized users connect to a target resource using a Secure Shell (SSH) for a predetermined amount of time.

Properties

bastionId

bastionId: string

The unique identifier (OCID) of the bastion that is hosting this session.

bastionName

bastionName: string

The name of the bastion that is hosting this session.

Optional bastionPublicHostKeyInfo

bastionPublicHostKeyInfo: undefined | string

The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.

Optional bastionUserName

bastionUserName: undefined | string

The username that the session uses to connect to the target resource.

Optional displayName

displayName: undefined | string

The name of the session.

id

id: string

The unique identifier (OCID) of the session, which can't be changed after creation.

keyDetails

keyDetails: PublicKeyDetails

Optional keyType

keyType: KeyType

The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current session state in more detail.

lifecycleState

lifecycleState: SessionLifecycleState

The current state of the session.

sessionTtlInSeconds

sessionTtlInSeconds: number

The amount of time the session can remain active. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sshMetadata

sshMetadata: undefined | object

The connection message for the session.

targetResourceDetails

timeCreated

timeCreated: Date

The time the session was created. Format is defined by RFC3339. Example: {@code 2020-01-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The time the session was updated. Format is defined by RFC3339. Example: {@code 2020-01-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Session): object

getJsonObj