AuthBackend
Manages a Github Auth mount in a Vault server. See the Vault documentation for more information.
Example Usage
using Pulumi;
using Vault = Pulumi.Vault;
class MyStack : Stack
{
public MyStack()
{
var example = new Vault.GitHub.AuthBackend("example", new Vault.GitHub.AuthBackendArgs
{
Organization = "myorg",
});
}
}
Coming soon!
import pulumi
import pulumi_vault as vault
example = vault.github.AuthBackend("example", organization="myorg")import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.github.AuthBackend("example", {
organization: "myorg",
});Create a AuthBackend Resource
new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);def AuthBackend(resource_name, opts=None, base_url=None, description=None, max_ttl=None, organization=None, path=None, token_bound_cidrs=None, token_explicit_max_ttl=None, token_max_ttl=None, token_no_default_policy=None, token_num_uses=None, token_period=None, token_policies=None, token_ttl=None, token_type=None, ttl=None, tune=None, __props__=None);func NewAuthBackend(ctx *Context, name string, args AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args AuthBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AuthBackendArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
AuthBackend Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The AuthBackend resource accepts the following input properties:
- Organization string
The organization configured users must be part of.
- Base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- Description string
Specifies the description of the mount. This overrides the current stored value, if any.
- Max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- Path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- Token
Bound List<string>Cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- Token
Explicit intMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- Token
Max intTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- Token
Num intUses (Optional) The period, if any, in number of seconds to set on the token.
- Token
Period int (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- Token
Policies List<string> (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- Token
Ttl int (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- Ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- Tune
Auth
Backend Tune Args
- Organization string
The organization configured users must be part of.
- Base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- Description string
Specifies the description of the mount. This overrides the current stored value, if any.
- Max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- Path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- Token
Bound []stringCidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- Token
Explicit intMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- Token
Max intTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- Token
Num intUses (Optional) The period, if any, in number of seconds to set on the token.
- Token
Period int (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- Token
Policies []string (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- Token
Ttl int (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- Ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- Tune
Auth
Backend Tune
- organization string
The organization configured users must be part of.
- base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- description string
Specifies the description of the mount. This overrides the current stored value, if any.
- max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- token
Bound string[]Cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- token
Explicit numberMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- token
Max numberTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- token
Num numberUses (Optional) The period, if any, in number of seconds to set on the token.
- token
Period number (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- token
Policies string[] (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- token
Ttl number (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- tune
Auth
Backend Tune
- organization str
The organization configured users must be part of.
- base_
url str The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- description str
Specifies the description of the mount. This overrides the current stored value, if any.
- max_
ttl str (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- path str
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- token_
bound_ List[str]cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- token_
explicit_ floatmax_ ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- token_
max_ floatttl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- token_
num_ floatuses (Optional) The period, if any, in number of seconds to set on the token.
- token_
period float (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- token_
policies List[str] (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- token_
ttl float (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
type str Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- ttl str
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- tune
Dict[Auth
Backend Tune]
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthBackend resource produces the following output properties:
- Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- Id string
- The provider-assigned unique ID for this managed resource.
- Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- Id string
- The provider-assigned unique ID for this managed resource.
- accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- id string
- The provider-assigned unique ID for this managed resource.
- accessor str
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- id str
- The provider-assigned unique ID for this managed resource.
Look up an Existing AuthBackend Resource
Get an existing AuthBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AuthBackendState, opts?: CustomResourceOptions): AuthBackendstatic get(resource_name, id, opts=None, accessor=None, base_url=None, description=None, max_ttl=None, organization=None, path=None, token_bound_cidrs=None, token_explicit_max_ttl=None, token_max_ttl=None, token_no_default_policy=None, token_num_uses=None, token_period=None, token_policies=None, token_ttl=None, token_type=None, ttl=None, tune=None, __props__=None);func GetAuthBackend(ctx *Context, name string, id IDInput, state *AuthBackendState, opts ...ResourceOption) (*AuthBackend, error)public static AuthBackend Get(string name, Input<string> id, AuthBackendState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- Base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- Description string
Specifies the description of the mount. This overrides the current stored value, if any.
- Max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- Organization string
The organization configured users must be part of.
- Path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- Token
Bound List<string>Cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- Token
Explicit intMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- Token
Max intTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- Token
Num intUses (Optional) The period, if any, in number of seconds to set on the token.
- Token
Period int (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- Token
Policies List<string> (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- Token
Ttl int (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- Ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- Tune
Auth
Backend Tune Args
- Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- Base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- Description string
Specifies the description of the mount. This overrides the current stored value, if any.
- Max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- Organization string
The organization configured users must be part of.
- Path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- Token
Bound []stringCidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- Token
Explicit intMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- Token
Max intTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- Token
Num intUses (Optional) The period, if any, in number of seconds to set on the token.
- Token
Period int (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- Token
Policies []string (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- Token
Ttl int (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- Ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- Tune
Auth
Backend Tune
- accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- base
Url string The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- description string
Specifies the description of the mount. This overrides the current stored value, if any.
- max
Ttl string (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- organization string
The organization configured users must be part of.
- path string
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- token
Bound string[]Cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- token
Explicit numberMax Ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- token
Max numberTtl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- token
Num numberUses (Optional) The period, if any, in number of seconds to set on the token.
- token
Period number (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- token
Policies string[] (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- token
Ttl number (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- ttl string
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- tune
Auth
Backend Tune
- accessor str
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- base_
url str The API endpoint to use. Useful if you are running GitHub Enterprise or an API-compatible authentication server.
- description str
Specifies the description of the mount. This overrides the current stored value, if any.
- max_
ttl str (Optional; Deprecated, use
token_max_ttlinstead if you are running Vault >= 1.2) The maximum allowed lifetime of tokens issued using this role. This must be a valid duration string.- organization str
The organization configured users must be part of.
- path str
Path where the auth backend is mounted. Defaults to
auth/githubif not specified.- token_
bound_ List[str]cidrs (Optional) List of CIDR blocks; if set, specifies blocks of IP addresses which can authenticate successfully, and ties the resulting token to these blocks as well.
- token_
explicit_ floatmax_ ttl (Optional) If set, will encode an explicit max TTL onto the token in number of seconds. This is a hard cap even if
token_ttlandtoken_max_ttlwould otherwise allow a renewal.- token_
max_ floatttl (Optional) The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy (Optional) If set, the default policy will not be set on generated tokens; otherwise it will be added to the policies set in token_policies.
- token_
num_ floatuses (Optional) The period, if any, in number of seconds to set on the token.
- token_
period float (Optional) If set, indicates that the token generated using this role should never expire. The token should be renewed within the duration specified by this value. At each renewal, the token’s TTL will be set to the value of this field. Specified in seconds.
- token_
policies List[str] (Optional) List of policies to encode onto generated tokens. Depending on the auth method, this list may be supplemented by user/group/other values.
- token_
ttl float (Optional) The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
type str Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- ttl str
(Optional; Deprecated, use
token_ttlinstead if you are running Vault >= 1.2) The TTL period of tokens issued using this role. This must be a valid duration string.- tune
Dict[Auth
Backend Tune]
Supporting Types
AuthBackendTune
- Allowed
Response List<string>Headers List of headers to whitelist and allowing a plugin to include them in the response.
- Audit
Non List<string>Hmac Request Keys Specifies the list of keys that will not be HMAC’d by audit devices in the request data object.
- Audit
Non List<string>Hmac Response Keys Specifies the list of keys that will not be HMAC’d by audit devices in the response data object.
- Default
Lease stringTtl Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
- Listing
Visibility string Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.
- Max
Lease stringTtl Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
- Passthrough
Request List<string>Headers List of headers to whitelist and pass from the request to the backend.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- Allowed
Response []stringHeaders List of headers to whitelist and allowing a plugin to include them in the response.
- Audit
Non []stringHmac Request Keys Specifies the list of keys that will not be HMAC’d by audit devices in the request data object.
- Audit
Non []stringHmac Response Keys Specifies the list of keys that will not be HMAC’d by audit devices in the response data object.
- Default
Lease stringTtl Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
- Listing
Visibility string Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.
- Max
Lease stringTtl Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
- Passthrough
Request []stringHeaders List of headers to whitelist and pass from the request to the backend.
- Token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- allowed
Response string[]Headers List of headers to whitelist and allowing a plugin to include them in the response.
- audit
Non string[]Hmac Request Keys Specifies the list of keys that will not be HMAC’d by audit devices in the request data object.
- audit
Non string[]Hmac Response Keys Specifies the list of keys that will not be HMAC’d by audit devices in the response data object.
- default
Lease stringTtl Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
- listing
Visibility string Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.
- max
Lease stringTtl Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
- passthrough
Request string[]Headers List of headers to whitelist and pass from the request to the backend.
- token
Type string Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
- allowed
Response List[str]Headers List of headers to whitelist and allowing a plugin to include them in the response.
- audit
Non List[str]Hmac Request Keys Specifies the list of keys that will not be HMAC’d by audit devices in the request data object.
- audit
Non List[str]Hmac Response Keys Specifies the list of keys that will not be HMAC’d by audit devices in the response data object.
- default
Lease strTtl Specifies the default time-to-live. If set, this overrides the global default. Must be a valid duration string
- listing_
visibility str Specifies whether to show this mount in the UI-specific listing endpoint. Valid values are “unauth” or “hidden”.
- max
Lease strTtl Specifies the maximum time-to-live. If set, this overrides the global default. Must be a valid duration string
- passthrough
Request List[str]Headers List of headers to whitelist and pass from the request to the backend.
- token_
type str Specifies the type of tokens that should be returned by the mount. Valid values are “default-service”, “default-batch”, “service”, “batch”.
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vaultTerraform Provider.