HashiCorp Vault
getEntity
Required Vault Capabilities
Use of this resource requires the create
capability on /identity/lookup/entity
.
Example Usage
using Pulumi;
using Vault = Pulumi.Vault;
class MyStack : Stack
{
public MyStack()
{
var entity = Output.Create(Vault.Identity.GetEntity.InvokeAsync(new Vault.Identity.GetEntityArgs
{
EntityName = "entity_12345",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/identity"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identity.LookupEntity(ctx, &identity.LookupEntityArgs{
EntityName: pulumi.StringRef("entity_12345"),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_vault as vault
entity = vault.identity.get_entity(entity_name="entity_12345")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const entity = pulumi.output(vault.identity.getEntity({
entityName: "entity_12345",
}));
Coming soon!
Using getEntity
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>
function getEntityOutput(args: GetEntityOutputArgs, opts?: InvokeOptions): Output<GetEntityResult>
def get_entity(alias_id: Optional[str] = None,
alias_mount_accessor: Optional[str] = None,
alias_name: Optional[str] = None,
entity_id: Optional[str] = None,
entity_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEntityResult
def get_entity_output(alias_id: Optional[pulumi.Input[str]] = None,
alias_mount_accessor: Optional[pulumi.Input[str]] = None,
alias_name: Optional[pulumi.Input[str]] = None,
entity_id: Optional[pulumi.Input[str]] = None,
entity_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEntityResult]
func LookupEntity(ctx *Context, args *LookupEntityArgs, opts ...InvokeOption) (*LookupEntityResult, error)
func LookupEntityOutput(ctx *Context, args *LookupEntityOutputArgs, opts ...InvokeOption) LookupEntityResultOutput
> Note: This function is named LookupEntity
in the Go SDK.
public static class GetEntity
{
public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
public static Output<GetEntityResult> Invoke(GetEntityInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEntityResult> getEntity(GetEntityArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: vault:identity/getEntity:getEntity
Arguments:
# Arguments dictionary
The following arguments are supported:
- Alias
Id string ID of the alias.
- Alias
Mount stringAccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- Alias
Name string Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- Entity
Id string ID of the entity.
- Entity
Name string Name of the entity.
- Alias
Id string ID of the alias.
- Alias
Mount stringAccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- Alias
Name string Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- Entity
Id string ID of the entity.
- Entity
Name string Name of the entity.
- alias
Id String ID of the alias.
- alias
Mount StringAccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- alias
Name String Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- entity
Id String ID of the entity.
- entity
Name String Name of the entity.
- alias
Id string ID of the alias.
- alias
Mount stringAccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- alias
Name string Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- entity
Id string ID of the entity.
- entity
Name string Name of the entity.
- alias_
id str ID of the alias.
- alias_
mount_ straccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- alias_
name str Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- entity_
id str ID of the entity.
- entity_
name str Name of the entity.
- alias
Id String ID of the alias.
- alias
Mount StringAccessor Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with
alias_name
.- alias
Name String Name of the alias. This should be supplied in conjunction with
alias_mount_accessor
.- entity
Id String ID of the entity.
- entity
Name String Name of the entity.
getEntity Result
The following output properties are available:
- Alias
Id string - Alias
Mount stringAccessor - Alias
Name string - Aliases
List<Get
Entity Alias> A list of entity alias. Structure is documented below.
- Creation
Time string Creation time of the Alias
- Data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- Direct
Group List<string>Ids List of Group IDs of which the entity is directly a member of
- Disabled bool
Whether the entity is disabled
- Entity
Id string - Entity
Name string - Group
Ids List<string> List of all Group IDs of which the entity is a member of
- Id string
The provider-assigned unique ID for this managed resource.
- Inherited
Group List<string>Ids List of all Group IDs of which the entity is a member of transitively
- Last
Update stringTime Last update time of the alias
- Merged
Entity List<string>Ids Other entity IDs which is merged with this entity
- Metadata Dictionary<string, object>
Arbitrary metadata
- Namespace
Id string Namespace of which the entity is part of
- Policies List<string>
List of policies attached to the entity
- Alias
Id string - Alias
Mount stringAccessor - Alias
Name string - Aliases
[]Get
Entity Alias Type A list of entity alias. Structure is documented below.
- Creation
Time string Creation time of the Alias
- Data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- Direct
Group []stringIds List of Group IDs of which the entity is directly a member of
- Disabled bool
Whether the entity is disabled
- Entity
Id string - Entity
Name string - Group
Ids []string List of all Group IDs of which the entity is a member of
- Id string
The provider-assigned unique ID for this managed resource.
- Inherited
Group []stringIds List of all Group IDs of which the entity is a member of transitively
- Last
Update stringTime Last update time of the alias
- Merged
Entity []stringIds Other entity IDs which is merged with this entity
- Metadata map[string]interface{}
Arbitrary metadata
- Namespace
Id string Namespace of which the entity is part of
- Policies []string
List of policies attached to the entity
- alias
Id String - alias
Mount StringAccessor - alias
Name String - aliases
List
Entity Alias> A list of entity alias. Structure is documented below.
- creation
Time String Creation time of the Alias
- data
Json String A string containing the full data payload retrieved from Vault, serialized in JSON format.
- direct
Group ListIds List of Group IDs of which the entity is directly a member of
- disabled Boolean
Whether the entity is disabled
- entity
Id String - entity
Name String - group
Ids List List of all Group IDs of which the entity is a member of
- id String
The provider-assigned unique ID for this managed resource.
- inherited
Group ListIds List of all Group IDs of which the entity is a member of transitively
- last
Update StringTime Last update time of the alias
- merged
Entity ListIds Other entity IDs which is merged with this entity
- metadata
Map
Arbitrary metadata
- namespace
Id String Namespace of which the entity is part of
- policies
List
List of policies attached to the entity
- alias
Id string - alias
Mount stringAccessor - alias
Name string - aliases
Get
Entity Alias[] A list of entity alias. Structure is documented below.
- creation
Time string Creation time of the Alias
- data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- direct
Group string[]Ids List of Group IDs of which the entity is directly a member of
- disabled boolean
Whether the entity is disabled
- entity
Id string - entity
Name string - group
Ids string[] List of all Group IDs of which the entity is a member of
- id string
The provider-assigned unique ID for this managed resource.
- inherited
Group string[]Ids List of all Group IDs of which the entity is a member of transitively
- last
Update stringTime Last update time of the alias
- merged
Entity string[]Ids Other entity IDs which is merged with this entity
- metadata {[key: string]: any}
Arbitrary metadata
- namespace
Id string Namespace of which the entity is part of
- policies string[]
List of policies attached to the entity
- alias_
id str - alias_
mount_ straccessor - alias_
name str - aliases
Sequence[Get
Entity Alias] A list of entity alias. Structure is documented below.
- creation_
time str Creation time of the Alias
- data_
json str A string containing the full data payload retrieved from Vault, serialized in JSON format.
- direct_
group_ Sequence[str]ids List of Group IDs of which the entity is directly a member of
- disabled bool
Whether the entity is disabled
- entity_
id str - entity_
name str - group_
ids Sequence[str] List of all Group IDs of which the entity is a member of
- id str
The provider-assigned unique ID for this managed resource.
- inherited_
group_ Sequence[str]ids List of all Group IDs of which the entity is a member of transitively
- last_
update_ strtime Last update time of the alias
- merged_
entity_ Sequence[str]ids Other entity IDs which is merged with this entity
- metadata Mapping[str, Any]
Arbitrary metadata
- namespace_
id str Namespace of which the entity is part of
- policies Sequence[str]
List of policies attached to the entity
- alias
Id String - alias
Mount StringAccessor - alias
Name String - aliases
List
A list of entity alias. Structure is documented below.
- creation
Time String Creation time of the Alias
- data
Json String A string containing the full data payload retrieved from Vault, serialized in JSON format.
- direct
Group ListIds List of Group IDs of which the entity is directly a member of
- disabled Boolean
Whether the entity is disabled
- entity
Id String - entity
Name String - group
Ids List List of all Group IDs of which the entity is a member of
- id String
The provider-assigned unique ID for this managed resource.
- inherited
Group ListIds List of all Group IDs of which the entity is a member of transitively
- last
Update StringTime Last update time of the alias
- merged
Entity ListIds Other entity IDs which is merged with this entity
- metadata
Map
Arbitrary metadata
- namespace
Id String Namespace of which the entity is part of
- policies
List
List of policies attached to the entity
Supporting Types
GetEntityAlias
- Canonical
Id string Canonical ID of the Alias
- Creation
Time string Creation time of the Alias
- Id string
ID of the alias
- Last
Update stringTime Last update time of the alias
- Merged
From List<string>Canonical Ids List of canonical IDs merged with this alias
- Metadata Dictionary<string, object>
Arbitrary metadata
- Mount
Accessor string Authentication mount acccessor which this alias belongs to
- Mount
Path string Authentication mount path which this alias belongs to
- Mount
Type string Authentication mount type which this alias belongs to
- Name string
Name of the alias
- Canonical
Id string Canonical ID of the Alias
- Creation
Time string Creation time of the Alias
- Id string
ID of the alias
- Last
Update stringTime Last update time of the alias
- Merged
From []stringCanonical Ids List of canonical IDs merged with this alias
- Metadata map[string]interface{}
Arbitrary metadata
- Mount
Accessor string Authentication mount acccessor which this alias belongs to
- Mount
Path string Authentication mount path which this alias belongs to
- Mount
Type string Authentication mount type which this alias belongs to
- Name string
Name of the alias
- canonical
Id String Canonical ID of the Alias
- creation
Time String Creation time of the Alias
- id String
ID of the alias
- last
Update StringTime Last update time of the alias
- merged
From ListCanonical Ids List of canonical IDs merged with this alias
- metadata
Map
Arbitrary metadata
- mount
Accessor String Authentication mount acccessor which this alias belongs to
- mount
Path String Authentication mount path which this alias belongs to
- mount
Type String Authentication mount type which this alias belongs to
- name String
Name of the alias
- canonical
Id string Canonical ID of the Alias
- creation
Time string Creation time of the Alias
- id string
ID of the alias
- last
Update stringTime Last update time of the alias
- merged
From string[]Canonical Ids List of canonical IDs merged with this alias
- metadata {[key: string]: any}
Arbitrary metadata
- mount
Accessor string Authentication mount acccessor which this alias belongs to
- mount
Path string Authentication mount path which this alias belongs to
- mount
Type string Authentication mount type which this alias belongs to
- name string
Name of the alias
- canonical_
id str Canonical ID of the Alias
- creation_
time str Creation time of the Alias
- id str
ID of the alias
- last_
update_ strtime Last update time of the alias
- merged_
from_ Sequence[str]canonical_ ids List of canonical IDs merged with this alias
- metadata Mapping[str, Any]
Arbitrary metadata
- mount_
accessor str Authentication mount acccessor which this alias belongs to
- mount_
path str Authentication mount path which this alias belongs to
- mount_
type str Authentication mount type which this alias belongs to
- name str
Name of the alias
- canonical
Id String Canonical ID of the Alias
- creation
Time String Creation time of the Alias
- id String
ID of the alias
- last
Update StringTime Last update time of the alias
- merged
From ListCanonical Ids List of canonical IDs merged with this alias
- metadata
Map
Arbitrary metadata
- mount
Accessor String Authentication mount acccessor which this alias belongs to
- mount
Path String Authentication mount path which this alias belongs to
- mount
Type String Authentication mount type which this alias belongs to
- name String
Name of the alias
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.