Class GatewayMetadata

Namespace

OpenShell.Gateway

Assembly

OpenShell.Sdk.dll

A registered gateway read from metadata.json.

public sealed record GatewayMetadata : IEquatable<GatewayMetadata>

Inheritance

object

GatewayMetadata

Implements

IEquatable<GatewayMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AuthMode

Authentication mode.

public GatewayAuthMode AuthMode { get; init; }

Property Value

GatewayAuthMode

Directory

Registration directory holding metadata.json: the user or the system gateway directory.

public required string Directory { get; init; }

Property Value

string

Endpoint

Gateway endpoint URL.

public required Uri Endpoint { get; init; }

Property Value

Uri

Name

Gateway name (the registration directory name).

public required string Name { get; init; }

Property Value

string

OidcAudience

OIDC audience.

public string? OidcAudience { get; init; }

Property Value

string

OidcClientId

OIDC client id.

public string? OidcClientId { get; init; }

Property Value

string

OidcIssuer

OIDC issuer URL, when the gateway uses OIDC.

public string? OidcIssuer { get; init; }

Property Value

string

OidcScopes

Space-separated OIDC scopes.

public string? OidcScopes { get; init; }

Property Value

string

Source

Where the registration was found.

public GatewayConfigSource Source { get; init; }

Property Value

GatewayConfigSource

StateDirectory

Per-user directory holding the gateway's credentials: the mtls bundle, oidc_token.json and edge_token. As in the OpenShell CLI it is always the user gateway directory, also for a system registration, because only active_gateway and metadata.json come from the system configuration. Defaults to Directory.

public string StateDirectory { get; init; }

Property Value

string