GetEntity

Using GetEntity

function getEntity(args: GetEntityArgs, opts?: InvokeOptions): Promise<GetEntityResult>

function  get_entity(alias_id=None, alias_mount_accessor=None, alias_name=None, entity_id=None, entity_name=None, opts=None)

func LookupEntity(ctx *Context, args *LookupEntityArgs, opts ...InvokeOption) (*LookupEntityResult, error)

Note: This function is named LookupEntity in the Go SDK.

public static class GetEntity {
    public static Task<GetEntityResult> InvokeAsync(GetEntityArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

AliasId string: ID of the alias.
AliasMountAccessor string: Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
AliasName string: Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
EntityId string: ID of the entity.
EntityName string: Name of the entity.

AliasId string: ID of the alias.
AliasMountAccessor string: Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
AliasName string: Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
EntityId string: ID of the entity.
EntityName string: Name of the entity.

aliasId string: ID of the alias.
aliasMountAccessor string: Accessor of the mount to which the alias belongs to. This should be supplied in conjunction with alias_name.
aliasName string: Name of the alias. This should be supplied in conjunction with alias_mount_accessor.
entityId string: ID of the entity.
entityName string: Name of the entity.

alias_id str: ID of the alias.
alias_mount_accessor str: 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.

GetEntity Result

The following output properties are available:

AliasId string
AliasMountAccessor string
AliasName string
Aliases List<GetEntityAlias>: A list of entity alias. Structure is documented below.
CreationTime string: Creation time of the Alias
DataJson string: A string containing the full data payload retrieved from Vault, serialized in JSON format.
DirectGroupIds List<string>: List of Group IDs of which the entity is directly a member of
Disabled bool: Whether the entity is disabled
EntityId string
EntityName string
GroupIds 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.
InheritedGroupIds List<string>: List of all Group IDs of which the entity is a member of transitively
LastUpdateTime string: Last update time of the alias
MergedEntityIds List<string>: Other entity IDs which is merged with this entity
Metadata Dictionary<string, object>: Arbitrary metadata
NamespaceId string: Namespace of which the entity is part of
Policies List<string>: List of policies attached to the entity

AliasId string
AliasMountAccessor string
AliasName string
Aliases []GetEntityAliasType: A list of entity alias. Structure is documented below.
CreationTime string: Creation time of the Alias
DataJson string: A string containing the full data payload retrieved from Vault, serialized in JSON format.
DirectGroupIds []string: List of Group IDs of which the entity is directly a member of
Disabled bool: Whether the entity is disabled
EntityId string
EntityName string
GroupIds []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.
InheritedGroupIds []string: List of all Group IDs of which the entity is a member of transitively
LastUpdateTime string: Last update time of the alias
MergedEntityIds []string: Other entity IDs which is merged with this entity
Metadata map[string]interface{}: Arbitrary metadata
NamespaceId string: Namespace of which the entity is part of
Policies []string: List of policies attached to the entity

aliasId string
aliasMountAccessor string
aliasName string
aliases GetEntityAlias[]: A list of entity alias. Structure is documented below.
creationTime string: Creation time of the Alias
dataJson string: A string containing the full data payload retrieved from Vault, serialized in JSON format.
directGroupIds string[]: List of Group IDs of which the entity is directly a member of
disabled boolean: Whether the entity is disabled
entityId string
entityName string
groupIds 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.
inheritedGroupIds string[]: List of all Group IDs of which the entity is a member of transitively
lastUpdateTime string: Last update time of the alias
mergedEntityIds string[]: Other entity IDs which is merged with this entity
metadata {[key: string]: any}: Arbitrary metadata
namespaceId string: Namespace of which the entity is part of
policies string[]: List of policies attached to the entity

alias_id str
alias_mount_accessor str
alias_name str
aliases List[GetEntityAlias]: 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_ids List[str]: 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 List[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_ids List[str]: List of all Group IDs of which the entity is a member of transitively
last_update_time str: Last update time of the alias
merged_entity_ids List[str]: Other entity IDs which is merged with this entity
metadata Dict[str, Any]: Arbitrary metadata
namespace_id str: Namespace of which the entity is part of
policies List[str]: List of policies attached to the entity

Supporting Types

GetEntityAlias

See the output API doc for this type.

CanonicalId string: Canonical ID of the Alias
CreationTime string: Creation time of the Alias
Id string: ID of the alias
LastUpdateTime string: Last update time of the alias
MergedFromCanonicalIds List<string>: List of canonical IDs merged with this alias
Metadata Dictionary<string, object>: Arbitrary metadata
MountAccessor string: Authentication mount acccessor which this alias belongs to
MountPath string: Authentication mount path which this alias belongs to
MountType string: Authentication mount type which this alias belongs to
Name string: Name of the alias

CanonicalId string: Canonical ID of the Alias
CreationTime string: Creation time of the Alias
Id string: ID of the alias
LastUpdateTime string: Last update time of the alias
MergedFromCanonicalIds []string: List of canonical IDs merged with this alias
Metadata map[string]interface{}: Arbitrary metadata
MountAccessor string: Authentication mount acccessor which this alias belongs to
MountPath string: Authentication mount path which this alias belongs to
MountType string: Authentication mount type which this alias belongs to
Name string: Name of the alias

canonicalId string: Canonical ID of the Alias
creationTime string: Creation time of the Alias
id string: ID of the alias
lastUpdateTime string: Last update time of the alias
mergedFromCanonicalIds string[]: List of canonical IDs merged with this alias
metadata {[key: string]: any}: Arbitrary metadata
mountAccessor string: Authentication mount acccessor which this alias belongs to
mountPath string: Authentication mount path which this alias belongs to
mountType string: Authentication mount type which this alias belongs to
name string: Name of the alias

canonical_id str: Canonical ID of the Alias
creationTime str: Creation time of the Alias
id str: ID of the alias
lastUpdateTime str: Last update time of the alias
mergedFromCanonicalIds List[str]: List of canonical IDs merged with this alias
metadata Dict[str, Any]: Arbitrary metadata
mountPath str: Authentication mount path which this alias belongs to
mountType str: Authentication mount type which this alias belongs to
mount_accessor str: Authentication mount acccessor which this alias belongs to
name str: 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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetEntity

Using GetEntity

GetEntity Result

Supporting Types

GetEntityAlias

Package Details

On This Page