Class AuthBackend

Inheritance

System.Object

Resource

CustomResource

AuthBackend

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Vault.Okta

Assembly: Pulumi.Vault.dll

Syntax

public class AuthBackend : CustomResource

Constructors

AuthBackend(String, AuthBackendArgs, CustomResourceOptions)

Create a AuthBackend resource with the given unique name, arguments, and options.

Declaration

public AuthBackend(string name, AuthBackendArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthBackendArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Accessor

The mount accessor related to the auth mount. It is useful for integration with Identity Secrets Engine.

Declaration

public Output<string> Accessor { get; }

Property Value

Type	Description
Output<System.String>

BaseUrl

The Okta url. Examples: oktapreview.com, okta.com

Declaration

public Output<string> BaseUrl { get; }

Property Value

Type	Description
Output<System.String>

BypassOktaMfa

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.

Declaration

public Output<bool?> BypassOktaMfa { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Description

The description of the auth backend

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Groups

Associate Okta groups with policies within Vault. See below for more details.

Declaration

public Output<ImmutableArray<AuthBackendGroup>> Groups { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AuthBackendGroup>>

MaxTtl

Maximum duration after which authentication will be expired See the documentation for info on valid duration formats.

Declaration

public Output<string> MaxTtl { get; }

Property Value

Type	Description
Output<System.String>

Organization

The Okta organization. This will be the first part of the url https://XXX.okta.com

Declaration

public Output<string> Organization { get; }

Property Value

Type	Description
Output<System.String>

Path

Path to mount the Okta auth backend

Declaration

public Output<string> Path { get; }

Property Value

Type	Description
Output<System.String>

Token

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.

Declaration

public Output<string> Token { get; }

Property Value

Type	Description
Output<System.String>

Ttl

Duration after which authentication will be expired. See the documentation for info on valid duration formats.

Declaration

public Output<string> Ttl { get; }

Property Value

Type	Description
Output<System.String>

Users

Associate Okta users with groups or policies within Vault. See below for more details.

Declaration

public Output<ImmutableArray<AuthBackendUser>> Users { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AuthBackendUser>>

Methods

Get(String, Input<String>, AuthBackendState, CustomResourceOptions)

Get an existing AuthBackend resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static AuthBackend Get(string name, Input<string> id, AuthBackendState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthBackendState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthBackend