AuthBackend

Create a AuthBackend Resource

new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);

def AuthBackend(resource_name, opts=None, base_url=None, bypass_okta_mfa=None, description=None, groups=None, max_ttl=None, organization=None, path=None, token=None, ttl=None, users=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 Okta organization. This will be the first part of the url https://XXX.okta.com
BaseUrl string: The Okta url. Examples: oktapreview.com, okta.com
BypassOktaMfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
Description string: The description of the auth backend
Groups List<AuthBackendGroupArgs>: Associate Okta groups with policies within Vault. See below for more details.
MaxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
Path string: Path to mount the Okta auth backend
Token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
Ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users List<AuthBackendUserArgs>: Associate Okta users with groups or policies within Vault. See below for more details.

Organization string: The Okta organization. This will be the first part of the url https://XXX.okta.com
BaseUrl string: The Okta url. Examples: oktapreview.com, okta.com
BypassOktaMfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
Description string: The description of the auth backend
Groups []AuthBackendGroupType: Associate Okta groups with policies within Vault. See below for more details.
MaxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
Path string: Path to mount the Okta auth backend
Token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
Ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users []AuthBackendUserType: Associate Okta users with groups or policies within Vault. See below for more details.

organization string: The Okta organization. This will be the first part of the url https://XXX.okta.com
baseUrl string: The Okta url. Examples: oktapreview.com, okta.com
bypassOktaMfa boolean: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
description string: The description of the auth backend
groups AuthBackendGroup[]: Associate Okta groups with policies within Vault. See below for more details.
maxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
path string: Path to mount the Okta auth backend
token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users AuthBackendUser[]: Associate Okta users with groups or policies within Vault. See below for more details.

organization str: The Okta organization. This will be the first part of the url https://XXX.okta.com
base_url str: The Okta url. Examples: oktapreview.com, okta.com
bypass_okta_mfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
description str: The description of the auth backend
groups List[AuthBackendGroup]: Associate Okta groups with policies within Vault. See below for more details.
max_ttl str: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
path str: Path to mount the Okta auth backend
token str: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
ttl str: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users List[AuthBackendUser]: Associate Okta users with groups or policies within Vault. See below for more details.

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): AuthBackend

static get(resource_name, id, opts=None, accessor=None, base_url=None, bypass_okta_mfa=None, description=None, groups=None, max_ttl=None, organization=None, path=None, token=None, ttl=None, users=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.
BaseUrl string: The Okta url. Examples: oktapreview.com, okta.com
BypassOktaMfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
Description string: The description of the auth backend
Groups List<AuthBackendGroupArgs>: Associate Okta groups with policies within Vault. See below for more details.
MaxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
Organization string: The Okta organization. This will be the first part of the url https://XXX.okta.com
Path string: Path to mount the Okta auth backend
Token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
Ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users List<AuthBackendUserArgs>: Associate Okta users with groups or policies within Vault. See below for more details.

Accessor string: The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
BaseUrl string: The Okta url. Examples: oktapreview.com, okta.com
BypassOktaMfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
Description string: The description of the auth backend
Groups []AuthBackendGroupType: Associate Okta groups with policies within Vault. See below for more details.
MaxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
Organization string: The Okta organization. This will be the first part of the url https://XXX.okta.com
Path string: Path to mount the Okta auth backend
Token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
Ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
Users []AuthBackendUserType: Associate Okta users with groups or policies within Vault. See below for more details.

accessor string: The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
baseUrl string: The Okta url. Examples: oktapreview.com, okta.com
bypassOktaMfa boolean: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
description string: The description of the auth backend
groups AuthBackendGroup[]: Associate Okta groups with policies within Vault. See below for more details.
maxTtl string: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
organization string: The Okta organization. This will be the first part of the url https://XXX.okta.com
path string: Path to mount the Okta auth backend
token string: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
ttl string: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users AuthBackendUser[]: Associate Okta users with groups or policies within Vault. See below for more details.

accessor str: The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
base_url str: The Okta url. Examples: oktapreview.com, okta.com
bypass_okta_mfa bool: When true, requests by Okta for a MFA check will be bypassed. This also disallows certain status checks on the account, such as whether the password is expired.
description str: The description of the auth backend
groups List[AuthBackendGroup]: Associate Okta groups with policies within Vault. See below for more details.
max_ttl str: Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
organization str: The Okta organization. This will be the first part of the url https://XXX.okta.com
path str: Path to mount the Okta auth backend
token str: The Okta API token. This is required to query Okta for user group membership. If this is not supplied only locally configured groups will be enabled.
ttl str: Duration after which authentication will be expired. See the documentation for info on valid duration formats.
users List[AuthBackendUser]: Associate Okta users with groups or policies within Vault. See below for more details.

Supporting Types

AuthBackendGroup

See the input and output API doc for this type.

GroupName string: Name of the group within the Okta
Policies List<string>: List of Vault policies to associate with this user

GroupName string: Name of the group within the Okta
Policies []string: List of Vault policies to associate with this user

groupName string: Name of the group within the Okta
policies string[]: List of Vault policies to associate with this user

group_name str: Name of the group within the Okta
policies List[str]: List of Vault policies to associate with this user

AuthBackendUser

See the input and output API doc for this type.

Groups List<string>: List of Okta groups to associate with this user
Username string: Name of the user within Okta
Policies List<string>: List of Vault policies to associate with this user

Groups []string: List of Okta groups to associate with this user
Username string: Name of the user within Okta
Policies []string: List of Vault policies to associate with this user

groups string[]: List of Okta groups to associate with this user
username string: Name of the user within Okta
policies string[]: List of Vault policies to associate with this user

groups List[str]: List of Okta groups to associate with this user
username str: Name of the user within Okta
policies List[str]: List of Vault policies to associate with this user

Package Details

Repository: https://github.com/pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud