HashiCorp Vault v5.11.0, Apr 25 23
HashiCorp Vault v5.11.0, Apr 25 23
vault.okta.AuthBackend
Explore with Pulumi AI
Provides a resource for managing an Okta auth backend within Vault.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var example = new Vault.Okta.AuthBackend("example", new()
{
Description = "Demonstration of the Terraform Okta auth backend",
Groups = new[]
{
new Vault.Okta.Inputs.AuthBackendGroupArgs
{
GroupName = "foo",
Policies = new[]
{
"one",
"two",
},
},
},
Organization = "example",
Token = "something that should be kept secret",
Users = new[]
{
new Vault.Okta.Inputs.AuthBackendUserArgs
{
Groups = new[]
{
"foo",
},
Username = "bar",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/okta"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := okta.NewAuthBackend(ctx, "example", &okta.AuthBackendArgs{
Description: pulumi.String("Demonstration of the Terraform Okta auth backend"),
Groups: okta.AuthBackendGroupTypeArray{
&okta.AuthBackendGroupTypeArgs{
GroupName: pulumi.String("foo"),
Policies: pulumi.StringArray{
pulumi.String("one"),
pulumi.String("two"),
},
},
},
Organization: pulumi.String("example"),
Token: pulumi.String("something that should be kept secret"),
Users: okta.AuthBackendUserTypeArray{
&okta.AuthBackendUserTypeArgs{
Groups: pulumi.StringArray{
pulumi.String("foo"),
},
Username: pulumi.String("bar"),
},
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.okta.AuthBackend;
import com.pulumi.vault.okta.AuthBackendArgs;
import com.pulumi.vault.okta.inputs.AuthBackendGroupArgs;
import com.pulumi.vault.okta.inputs.AuthBackendUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AuthBackend("example", AuthBackendArgs.builder()
.description("Demonstration of the Terraform Okta auth backend")
.groups(AuthBackendGroupArgs.builder()
.groupName("foo")
.policies(
"one",
"two")
.build())
.organization("example")
.token("something that should be kept secret")
.users(AuthBackendUserArgs.builder()
.groups("foo")
.username("bar")
.build())
.build());
}
}
import pulumi
import pulumi_vault as vault
example = vault.okta.AuthBackend("example",
description="Demonstration of the Terraform Okta auth backend",
groups=[vault.okta.AuthBackendGroupArgs(
group_name="foo",
policies=[
"one",
"two",
],
)],
organization="example",
token="something that should be kept secret",
users=[vault.okta.AuthBackendUserArgs(
groups=["foo"],
username="bar",
)])
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const example = new vault.okta.AuthBackend("example", {
description: "Demonstration of the Terraform Okta auth backend",
groups: [{
groupName: "foo",
policies: [
"one",
"two",
],
}],
organization: "example",
token: "something that should be kept secret",
users: [{
groups: ["foo"],
username: "bar",
}],
});
resources:
example:
type: vault:okta:AuthBackend
properties:
description: Demonstration of the Terraform Okta auth backend
groups:
- groupName: foo
policies:
- one
- two
organization: example
token: something that should be kept secret
users:
- groups:
- foo
username: bar
Create AuthBackend Resource
new AuthBackend(name: string, args: AuthBackendArgs, opts?: CustomResourceOptions);
@overload
def AuthBackend(resource_name: str,
opts: Optional[ResourceOptions] = None,
base_url: Optional[str] = None,
bypass_okta_mfa: Optional[bool] = None,
description: Optional[str] = None,
disable_remount: Optional[bool] = None,
groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
max_ttl: Optional[str] = None,
namespace: Optional[str] = None,
organization: Optional[str] = None,
path: Optional[str] = None,
token: Optional[str] = None,
ttl: Optional[str] = None,
users: Optional[Sequence[AuthBackendUserArgs]] = None)
@overload
def AuthBackend(resource_name: str,
args: AuthBackendArgs,
opts: Optional[ResourceOptions] = None)
func NewAuthBackend(ctx *Context, name string, args AuthBackendArgs, opts ...ResourceOption) (*AuthBackend, error)
public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions? opts = null)
public AuthBackend(String name, AuthBackendArgs args)
public AuthBackend(String name, AuthBackendArgs args, CustomResourceOptions options)
type: vault:okta:AuthBackend
properties: # The arguments to resource properties.
options: # 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.
- resource_name str
- The unique name of the resource.
- args AuthBackendArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args AuthBackendArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts 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
- Base
Url string The Okta url. Examples: oktapreview.com, okta.com
- Bypass
Okta boolMfa 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
- Disable
Remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Groups
List<Auth
Backend Group Args> Associate Okta groups with policies within Vault. See below for more details.
- Max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Path string
Path to mount the Okta auth backend. Default to path
okta
.- 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<Auth
Backend User Args> 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
- Base
Url string The Okta url. Examples: oktapreview.com, okta.com
- Bypass
Okta boolMfa 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
- Disable
Remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Groups
[]Auth
Backend Group Type Args Associate Okta groups with policies within Vault. See below for more details.
- Max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- Path string
Path to mount the Okta auth backend. Default to path
okta
.- 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
[]Auth
Backend User Type Args 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
- base
Url String The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta BooleanMfa 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
- disable
Remount Boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
List<Auth
Backend Group Args> Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl String Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- path String
Path to mount the Okta auth backend. Default to path
okta
.- 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<Auth
Backend User Args> 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
- base
Url string The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta booleanMfa 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
- disable
Remount boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
Auth
Backend Group Args[] Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- path string
Path to mount the Okta auth backend. Default to path
okta
.- 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
Auth
Backend User Args[] 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_ boolmfa 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
- disable_
remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
Sequence[Auth
Backend Group Args] 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.
- namespace str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- path str
Path to mount the Okta auth backend. Default to path
okta
.- 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
Sequence[Auth
Backend User Args] 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
- base
Url String The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta BooleanMfa 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
- disable
Remount Boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups List<Property Map>
Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl String Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- path String
Path to mount the Okta auth backend. Default to path
okta
.- 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<Property Map>
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 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.
- 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.
Look up 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accessor: Optional[str] = None,
base_url: Optional[str] = None,
bypass_okta_mfa: Optional[bool] = None,
description: Optional[str] = None,
disable_remount: Optional[bool] = None,
groups: Optional[Sequence[AuthBackendGroupArgs]] = None,
max_ttl: Optional[str] = None,
namespace: Optional[str] = None,
organization: Optional[str] = None,
path: Optional[str] = None,
token: Optional[str] = None,
ttl: Optional[str] = None,
users: Optional[Sequence[AuthBackendUserArgs]] = None) -> AuthBackend
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)
public static AuthBackend get(String name, Output<String> id, AuthBackendState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- Accessor string
The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.
- Base
Url string The Okta url. Examples: oktapreview.com, okta.com
- Bypass
Okta boolMfa 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
- Disable
Remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Groups
List<Auth
Backend Group Args> Associate Okta groups with policies within Vault. See below for more details.
- Max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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<Auth
Backend User Args> 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.
- Base
Url string The Okta url. Examples: oktapreview.com, okta.com
- Bypass
Okta boolMfa 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
- Disable
Remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Groups
[]Auth
Backend Group Type Args Associate Okta groups with policies within Vault. See below for more details.
- Max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- Namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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
[]Auth
Backend User Type Args 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.
- base
Url String The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta BooleanMfa 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
- disable
Remount Boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
List<Auth
Backend Group Args> Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl String Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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<Auth
Backend User Args> 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.
- base
Url string The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta booleanMfa 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
- disable
Remount boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
Auth
Backend Group Args[] Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl string Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace string
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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
Auth
Backend User Args[] 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_ boolmfa 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
- disable_
remount bool If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups
Sequence[Auth
Backend Group Args] 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.
- namespace str
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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
Sequence[Auth
Backend User Args] 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.
- base
Url String The Okta url. Examples: oktapreview.com, okta.com
- bypass
Okta BooleanMfa 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
- disable
Remount Boolean If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- groups List<Property Map>
Associate Okta groups with policies within Vault. See below for more details.
- max
Ttl String Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.
- namespace String
The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise.- 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. Default to path
okta
.- 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<Property Map>
Associate Okta users with groups or policies within Vault. See below for more details.
Supporting Types
AuthBackendGroup
- group_
name str Name of the group within the Okta
- policies Sequence[str]
List of Vault policies to associate with this user
AuthBackendUser
Import
Okta authentication backends can be imported using its path
, e.g.
$ pulumi import vault:okta/authBackend:AuthBackend example okta
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.