AppRoleAuthenticationOptions Class

The AppRole auth method: the host proves who it is with a role and secret identifier pair.

public sealed class AppRoleAuthenticationOptions

Inheritance System.Object → AppRoleAuthenticationOptions

Remarks

The role behind these identifiers must issue a service token without a use limit (token_num_uses=0): every Transit call spends a use invisibly, so a limited token dies mid-flight with nothing naming the limit. And every login consumes a secret_id use, including logins retried after a lost response, so a bounded secret_id_num_uses runs out on schedule rather than on error.

Properties

AppRoleAuthenticationOptions.Mount Property

Mount path of the AppRole auth method (the default mount is approle).

public string Mount { get; set; }

Property Value

System.String

AppRoleAuthenticationOptions.RoleId Property

Identifier of the AppRole to log in as.

public string? RoleId { get; set; }

Property Value

System.String

AppRoleAuthenticationOptions.SecretId Property

The secret half of the pair. Source it from a secret store or a mounted secret, never hardcode it. It is re-read from configuration on every login, so a rotated value delivered through configuration reload is picked up without a restart.

public string? SecretId { get; set; }

Property Value

System.String