Class ProfileCredential

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

One credential a provider profile declares.

public sealed record ProfileCredential : IEquatable<ProfileCredential>

Inheritance

object

ProfileCredential

Implements

IEquatable<ProfileCredential>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AuthStyle

Authentication style.

public string AuthStyle { get; init; }

Property Value

string

Description

Description.

public string Description { get; init; }

Property Value

string

EnvVars

Environment variables that receive the value.

public IReadOnlyList<string> EnvVars { get; init; }

Property Value

IReadOnlyList<string>

HeaderName

Header name for header auth.

public string HeaderName { get; init; }

Property Value

string

Name

Credential name.

public string Name { get; init; }

Property Value

string

PathTemplate

Path template for path auth.

public string PathTemplate { get; init; }

Property Value

string

QueryParam

Query parameter name for query auth.

public string QueryParam { get; init; }

Property Value

string

Refresh

Refresh declaration.

public ProfileCredentialRefresh? Refresh { get; init; }

Property Value

ProfileCredentialRefresh

Required

Whether the credential is required.

public bool Required { get; init; }

Property Value

bool

StablePlaceholder

Keeps one opaque, identity-bound environment placeholder across value-only provider revisions, instead of a new placeholder per revision. Requires at least one environment variable, and cannot be combined with gateway-managed refresh or a token grant. Import, update, and lint first check that the gateway supports it, because older gateways drop unknown fields silently.

public bool StablePlaceholder { get; init; }

Property Value

bool

TokenGrant

Token grant declaration.

public CredentialTokenGrant? TokenGrant { get; init; }

Property Value

CredentialTokenGrant