vault.saml.AuthBackendRole
Explore with Pulumi AI
Manages an SAML auth backend role in a Vault server. See the Vault documentation for more information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const exampleAuthBackend = new vault.saml.AuthBackend("exampleAuthBackend", {
path: "saml",
idpMetadataUrl: "https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
entityId: "https://my.vault/v1/auth/saml",
acsUrls: ["https://my.vault.primary/v1/auth/saml/callback"],
defaultRole: "default-role",
});
const exampleAuthBackendRole = new vault.saml.AuthBackendRole("exampleAuthBackendRole", {
path: exampleAuthBackend.path,
groupsAttribute: "groups",
boundAttributes: {
group: "admin",
},
boundSubjects: ["*example.com"],
tokenPolicies: ["writer"],
tokenTtl: 86400,
});
import pulumi
import pulumi_vault as vault
example_auth_backend = vault.saml.AuthBackend("exampleAuthBackend",
path="saml",
idp_metadata_url="https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
entity_id="https://my.vault/v1/auth/saml",
acs_urls=["https://my.vault.primary/v1/auth/saml/callback"],
default_role="default-role")
example_auth_backend_role = vault.saml.AuthBackendRole("exampleAuthBackendRole",
path=example_auth_backend.path,
groups_attribute="groups",
bound_attributes={
"group": "admin",
},
bound_subjects=["*example.com"],
token_policies=["writer"],
token_ttl=86400)
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/saml"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleAuthBackend, err := saml.NewAuthBackend(ctx, "exampleAuthBackend", &saml.AuthBackendArgs{
Path: pulumi.String("saml"),
IdpMetadataUrl: pulumi.String("https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata"),
EntityId: pulumi.String("https://my.vault/v1/auth/saml"),
AcsUrls: pulumi.StringArray{
pulumi.String("https://my.vault.primary/v1/auth/saml/callback"),
},
DefaultRole: pulumi.String("default-role"),
})
if err != nil {
return err
}
_, err = saml.NewAuthBackendRole(ctx, "exampleAuthBackendRole", &saml.AuthBackendRoleArgs{
Path: exampleAuthBackend.Path,
GroupsAttribute: pulumi.String("groups"),
BoundAttributes: pulumi.Map{
"group": pulumi.Any("admin"),
},
BoundSubjects: pulumi.StringArray{
pulumi.String("*example.com"),
},
TokenPolicies: pulumi.StringArray{
pulumi.String("writer"),
},
TokenTtl: pulumi.Int(86400),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var exampleAuthBackend = new Vault.Saml.AuthBackend("exampleAuthBackend", new()
{
Path = "saml",
IdpMetadataUrl = "https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata",
EntityId = "https://my.vault/v1/auth/saml",
AcsUrls = new[]
{
"https://my.vault.primary/v1/auth/saml/callback",
},
DefaultRole = "default-role",
});
var exampleAuthBackendRole = new Vault.Saml.AuthBackendRole("exampleAuthBackendRole", new()
{
Path = exampleAuthBackend.Path,
GroupsAttribute = "groups",
BoundAttributes =
{
{ "group", "admin" },
},
BoundSubjects = new[]
{
"*example.com",
},
TokenPolicies = new[]
{
"writer",
},
TokenTtl = 86400,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.saml.AuthBackend;
import com.pulumi.vault.saml.AuthBackendArgs;
import com.pulumi.vault.saml.AuthBackendRole;
import com.pulumi.vault.saml.AuthBackendRoleArgs;
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 exampleAuthBackend = new AuthBackend("exampleAuthBackend", AuthBackendArgs.builder()
.path("saml")
.idpMetadataUrl("https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata")
.entityId("https://my.vault/v1/auth/saml")
.acsUrls("https://my.vault.primary/v1/auth/saml/callback")
.defaultRole("default-role")
.build());
var exampleAuthBackendRole = new AuthBackendRole("exampleAuthBackendRole", AuthBackendRoleArgs.builder()
.path(exampleAuthBackend.path())
.groupsAttribute("groups")
.boundAttributes(Map.of("group", "admin"))
.boundSubjects("*example.com")
.tokenPolicies("writer")
.tokenTtl(86400)
.build());
}
}
resources:
exampleAuthBackend:
type: vault:saml:AuthBackend
properties:
path: saml
idpMetadataUrl: https://company.okta.com/app/abc123eb9xnIfzlaf697/sso/saml/metadata
entityId: https://my.vault/v1/auth/saml
acsUrls:
- https://my.vault.primary/v1/auth/saml/callback
defaultRole: default-role
exampleAuthBackendRole:
type: vault:saml:AuthBackendRole
properties:
path: ${exampleAuthBackend.path}
groupsAttribute: groups
boundAttributes:
group: admin
boundSubjects:
- '*example.com'
tokenPolicies:
- writer
tokenTtl: 86400
Create AuthBackendRole Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuthBackendRole(name: string, args: AuthBackendRoleArgs, opts?: CustomResourceOptions);
@overload
def AuthBackendRole(resource_name: str,
args: AuthBackendRoleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AuthBackendRole(resource_name: str,
opts: Optional[ResourceOptions] = None,
path: Optional[str] = None,
token_bound_cidrs: Optional[Sequence[str]] = None,
bound_attributes_type: Optional[str] = None,
bound_subjects_type: Optional[str] = None,
groups_attribute: Optional[str] = None,
token_explicit_max_ttl: Optional[int] = None,
namespace: Optional[str] = None,
bound_subjects: Optional[Sequence[str]] = None,
bound_attributes: Optional[Mapping[str, Any]] = None,
name: Optional[str] = None,
token_max_ttl: Optional[int] = None,
token_no_default_policy: Optional[bool] = None,
token_num_uses: Optional[int] = None,
token_period: Optional[int] = None,
token_policies: Optional[Sequence[str]] = None,
token_ttl: Optional[int] = None,
token_type: Optional[str] = None)
func NewAuthBackendRole(ctx *Context, name string, args AuthBackendRoleArgs, opts ...ResourceOption) (*AuthBackendRole, error)
public AuthBackendRole(string name, AuthBackendRoleArgs args, CustomResourceOptions? opts = null)
public AuthBackendRole(String name, AuthBackendRoleArgs args)
public AuthBackendRole(String name, AuthBackendRoleArgs args, CustomResourceOptions options)
type: vault:saml:AuthBackendRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AuthBackendRoleArgs
- 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 AuthBackendRoleArgs
- 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 AuthBackendRoleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthBackendRoleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthBackendRoleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var exampleauthBackendRoleResourceResourceFromSamlauthBackendRole = new Vault.Saml.AuthBackendRole("exampleauthBackendRoleResourceResourceFromSamlauthBackendRole", new()
{
Path = "string",
TokenBoundCidrs = new[]
{
"string",
},
BoundAttributesType = "string",
BoundSubjectsType = "string",
GroupsAttribute = "string",
TokenExplicitMaxTtl = 0,
Namespace = "string",
BoundSubjects = new[]
{
"string",
},
BoundAttributes =
{
{ "string", "any" },
},
Name = "string",
TokenMaxTtl = 0,
TokenNoDefaultPolicy = false,
TokenNumUses = 0,
TokenPeriod = 0,
TokenPolicies = new[]
{
"string",
},
TokenTtl = 0,
TokenType = "string",
});
example, err := saml.NewAuthBackendRole(ctx, "exampleauthBackendRoleResourceResourceFromSamlauthBackendRole", &saml.AuthBackendRoleArgs{
Path: pulumi.String("string"),
TokenBoundCidrs: pulumi.StringArray{
pulumi.String("string"),
},
BoundAttributesType: pulumi.String("string"),
BoundSubjectsType: pulumi.String("string"),
GroupsAttribute: pulumi.String("string"),
TokenExplicitMaxTtl: pulumi.Int(0),
Namespace: pulumi.String("string"),
BoundSubjects: pulumi.StringArray{
pulumi.String("string"),
},
BoundAttributes: pulumi.Map{
"string": pulumi.Any("any"),
},
Name: pulumi.String("string"),
TokenMaxTtl: pulumi.Int(0),
TokenNoDefaultPolicy: pulumi.Bool(false),
TokenNumUses: pulumi.Int(0),
TokenPeriod: pulumi.Int(0),
TokenPolicies: pulumi.StringArray{
pulumi.String("string"),
},
TokenTtl: pulumi.Int(0),
TokenType: pulumi.String("string"),
})
var exampleauthBackendRoleResourceResourceFromSamlauthBackendRole = new AuthBackendRole("exampleauthBackendRoleResourceResourceFromSamlauthBackendRole", AuthBackendRoleArgs.builder()
.path("string")
.tokenBoundCidrs("string")
.boundAttributesType("string")
.boundSubjectsType("string")
.groupsAttribute("string")
.tokenExplicitMaxTtl(0)
.namespace("string")
.boundSubjects("string")
.boundAttributes(Map.of("string", "any"))
.name("string")
.tokenMaxTtl(0)
.tokenNoDefaultPolicy(false)
.tokenNumUses(0)
.tokenPeriod(0)
.tokenPolicies("string")
.tokenTtl(0)
.tokenType("string")
.build());
exampleauth_backend_role_resource_resource_from_samlauth_backend_role = vault.saml.AuthBackendRole("exampleauthBackendRoleResourceResourceFromSamlauthBackendRole",
path="string",
token_bound_cidrs=["string"],
bound_attributes_type="string",
bound_subjects_type="string",
groups_attribute="string",
token_explicit_max_ttl=0,
namespace="string",
bound_subjects=["string"],
bound_attributes={
"string": "any",
},
name="string",
token_max_ttl=0,
token_no_default_policy=False,
token_num_uses=0,
token_period=0,
token_policies=["string"],
token_ttl=0,
token_type="string")
const exampleauthBackendRoleResourceResourceFromSamlauthBackendRole = new vault.saml.AuthBackendRole("exampleauthBackendRoleResourceResourceFromSamlauthBackendRole", {
path: "string",
tokenBoundCidrs: ["string"],
boundAttributesType: "string",
boundSubjectsType: "string",
groupsAttribute: "string",
tokenExplicitMaxTtl: 0,
namespace: "string",
boundSubjects: ["string"],
boundAttributes: {
string: "any",
},
name: "string",
tokenMaxTtl: 0,
tokenNoDefaultPolicy: false,
tokenNumUses: 0,
tokenPeriod: 0,
tokenPolicies: ["string"],
tokenTtl: 0,
tokenType: "string",
});
type: vault:saml:AuthBackendRole
properties:
boundAttributes:
string: any
boundAttributesType: string
boundSubjects:
- string
boundSubjectsType: string
groupsAttribute: string
name: string
namespace: string
path: string
tokenBoundCidrs:
- string
tokenExplicitMaxTtl: 0
tokenMaxTtl: 0
tokenNoDefaultPolicy: false
tokenNumUses: 0
tokenPeriod: 0
tokenPolicies:
- string
tokenTtl: 0
tokenType: string
AuthBackendRole 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 AuthBackendRole resource accepts the following input properties:
- Path string
- Path where the auth backend is mounted.
- Bound
Attributes Dictionary<string, object> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- Bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - Bound
Subjects List<string> - List of subjects being asserted for SAML authentication.
- Bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - Groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- Name string
- Unique name of the role.
- 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. - Token
Bound List<string>Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - Token
Max intTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- Token
Period int - 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> - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Path string
- Path where the auth backend is mounted.
- Bound
Attributes map[string]interface{} - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- Bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - Bound
Subjects []string - List of subjects being asserted for SAML authentication.
- Bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - Groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- Name string
- Unique name of the role.
- 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. - Token
Bound []stringCidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - Token
Max intTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- Token
Period int - 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 - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- path String
- Path where the auth backend is mounted.
- bound
Attributes Map<String,Object> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes StringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects List<String> - List of subjects being asserted for SAML authentication.
- bound
Subjects StringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute String - The attribute to use to identify the set of groups to which the user belongs.
- name String
- Unique name of the role.
- 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. - token
Bound List<String>Cidrs - 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 IntegerMax Ttl - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max IntegerTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy - 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 IntegerUses - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period Integer - 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> - 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 Integer - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- path string
- Path where the auth backend is mounted.
- bound
Attributes {[key: string]: any} - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects string[] - List of subjects being asserted for SAML authentication.
- bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- name string
- Unique name of the role.
- 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. - token
Bound string[]Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max numberTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period number - 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[] - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- path str
- Path where the auth backend is mounted.
- bound_
attributes Mapping[str, Any] - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound_
attributes_ strtype - The type of matching assertion to perform on
bound_attributes_type
. - bound_
subjects Sequence[str] - List of subjects being asserted for SAML authentication.
- bound_
subjects_ strtype - The type of matching assertion to perform on
bound_subjects
. - groups_
attribute str - The attribute to use to identify the set of groups to which the user belongs.
- name str
- Unique name of the role.
- 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. - token_
bound_ Sequence[str]cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token_
max_ intttl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token_
period int - 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 Sequence[str] - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
type str - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- path String
- Path where the auth backend is mounted.
- bound
Attributes Map<Any> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes StringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects List<String> - List of subjects being asserted for SAML authentication.
- bound
Subjects StringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute String - The attribute to use to identify the set of groups to which the user belongs.
- name String
- Unique name of the role.
- 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. - token
Bound List<String>Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max NumberTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period Number - 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> - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthBackendRole resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AuthBackendRole Resource
Get an existing AuthBackendRole 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?: AuthBackendRoleState, opts?: CustomResourceOptions): AuthBackendRole
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bound_attributes: Optional[Mapping[str, Any]] = None,
bound_attributes_type: Optional[str] = None,
bound_subjects: Optional[Sequence[str]] = None,
bound_subjects_type: Optional[str] = None,
groups_attribute: Optional[str] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
path: Optional[str] = None,
token_bound_cidrs: Optional[Sequence[str]] = None,
token_explicit_max_ttl: Optional[int] = None,
token_max_ttl: Optional[int] = None,
token_no_default_policy: Optional[bool] = None,
token_num_uses: Optional[int] = None,
token_period: Optional[int] = None,
token_policies: Optional[Sequence[str]] = None,
token_ttl: Optional[int] = None,
token_type: Optional[str] = None) -> AuthBackendRole
func GetAuthBackendRole(ctx *Context, name string, id IDInput, state *AuthBackendRoleState, opts ...ResourceOption) (*AuthBackendRole, error)
public static AuthBackendRole Get(string name, Input<string> id, AuthBackendRoleState? state, CustomResourceOptions? opts = null)
public static AuthBackendRole get(String name, Output<String> id, AuthBackendRoleState 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.
- Bound
Attributes Dictionary<string, object> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- Bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - Bound
Subjects List<string> - List of subjects being asserted for SAML authentication.
- Bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - Groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- Name string
- Unique name of the role.
- 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 where the auth backend is mounted.
- Token
Bound List<string>Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - Token
Max intTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- Token
Period int - 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> - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- Bound
Attributes map[string]interface{} - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- Bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - Bound
Subjects []string - List of subjects being asserted for SAML authentication.
- Bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - Groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- Name string
- Unique name of the role.
- 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 where the auth backend is mounted.
- Token
Bound []stringCidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - Token
Max intTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
No boolDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- Token
Period int - 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 - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- Token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Attributes Map<String,Object> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes StringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects List<String> - List of subjects being asserted for SAML authentication.
- bound
Subjects StringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute String - The attribute to use to identify the set of groups to which the user belongs.
- name String
- Unique name of the role.
- 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 where the auth backend is mounted.
- token
Bound List<String>Cidrs - 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 IntegerMax Ttl - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max IntegerTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy - 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 IntegerUses - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period Integer - 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> - 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 Integer - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Attributes {[key: string]: any} - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes stringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects string[] - List of subjects being asserted for SAML authentication.
- bound
Subjects stringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute string - The attribute to use to identify the set of groups to which the user belongs.
- name string
- Unique name of the role.
- 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 where the auth backend is mounted.
- token
Bound string[]Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max numberTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No booleanDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period number - 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[] - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type string - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound_
attributes Mapping[str, Any] - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound_
attributes_ strtype - The type of matching assertion to perform on
bound_attributes_type
. - bound_
subjects Sequence[str] - List of subjects being asserted for SAML authentication.
- bound_
subjects_ strtype - The type of matching assertion to perform on
bound_subjects
. - groups_
attribute str - The attribute to use to identify the set of groups to which the user belongs.
- name str
- Unique name of the role.
- 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 where the auth backend is mounted.
- token_
bound_ Sequence[str]cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token_
max_ intttl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
no_ booldefault_ policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token_
period int - 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 Sequence[str] - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token_
type str - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
- bound
Attributes Map<Any> - Mapping of attribute names to values that are expected to exist in the SAML assertion.
- bound
Attributes StringType - The type of matching assertion to perform on
bound_attributes_type
. - bound
Subjects List<String> - List of subjects being asserted for SAML authentication.
- bound
Subjects StringType - The type of matching assertion to perform on
bound_subjects
. - groups
Attribute String - The attribute to use to identify the set of groups to which the user belongs.
- name String
- Unique name of the role.
- 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 where the auth backend is mounted.
- token
Bound List<String>Cidrs - 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 - If set, will encode an
explicit max TTL
onto the token in number of seconds. This is a hard cap even if
token_ttl
andtoken_max_ttl
would otherwise allow a renewal. - token
Max NumberTtl - The maximum lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
No BooleanDefault Policy - 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 - The maximum number of times a token may be used, a value of zero means unlimited
- token
Period Number - 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> - 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 - The incremental lifetime for generated tokens in number of seconds. Its current value will be referenced at renewal time.
- token
Type String - The type of token that should be generated. Can be
service
,batch
, ordefault
to use the mount's tuned default (which unless changed will beservice
tokens). For token store roles, there are two additional possibilities:default-service
anddefault-batch
which specify the type to return unless the client requests a different type at generation time.
Import
SAML authentication backend roles can be imported using the path
, e.g.
$ pulumi import vault:saml/authBackendRole:AuthBackendRole example auth/saml/role/my-role
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vault
Terraform Provider.