HashiCorp Vault
getGroup
Required Vault Capabilities
Use of this resource requires the create
capability on /identity/lookup/group
.
Example Usage
using Pulumi;
using Vault = Pulumi.Vault;
class MyStack : Stack
{
public MyStack()
{
var @group = Output.Create(Vault.Identity.GetGroup.InvokeAsync(new Vault.Identity.GetGroupArgs
{
GroupName = "user",
}));
}
}
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.LookupGroup(ctx, &identity.LookupGroupArgs{
GroupName: pulumi.StringRef("user"),
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_vault as vault
group = vault.identity.get_group(group_name="user")
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const group = pulumi.output(vault.identity.getGroup({
groupName: "user",
}));
Coming soon!
Using getGroup
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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(alias_id: Optional[str] = None,
alias_mount_accessor: Optional[str] = None,
alias_name: Optional[str] = None,
group_id: Optional[str] = None,
group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(alias_id: Optional[pulumi.Input[str]] = None,
alias_mount_accessor: Optional[pulumi.Input[str]] = None,
alias_name: Optional[pulumi.Input[str]] = None,
group_id: Optional[pulumi.Input[str]] = None,
group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
> Note: This function is named LookupGroup
in the Go SDK.
public static class GetGroup
{
public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: vault:identity/getGroup:getGroup
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
.- Group
Id string ID of the group.
- Group
Name string Name of the group.
- 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
.- Group
Id string ID of the group.
- Group
Name string Name of the group.
- 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
.- group
Id String ID of the group.
- group
Name String Name of the group.
- 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
.- group
Id string ID of the group.
- group
Name string Name of the group.
- 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
.- group_
id str ID of the group.
- group_
name str Name of the group.
- 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
.- group
Id String ID of the group.
- group
Name String Name of the group.
getGroup Result
The following output properties are available:
- Alias
Canonical stringId Canonical ID of the Alias
- Alias
Creation stringTime Creation time of the Alias
- Alias
Id string - Alias
Last stringUpdate Time Last update time of the alias
- Alias
Merged List<string>From Canonical Ids List of canonical IDs merged with this alias
- Alias
Metadata Dictionary<string, object> Arbitrary metadata
- Alias
Mount stringAccessor - Alias
Mount stringPath Authentication mount path which this alias belongs to
- Alias
Mount stringType Authentication mount type which this alias belongs to
- Alias
Name string - Creation
Time string Creation timestamp of the group
- Data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- Group
Id string - Group
Name string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Update stringTime Last updated time of the group
- Member
Entity List<string>Ids List of Entity IDs which are members of this group
- Member
Group List<string>Ids List of Group IDs which are members of this group
- Metadata Dictionary<string, object>
Arbitrary metadata
- Modify
Index int Modify index of the group
- Namespace
Id string Namespace of which the group is part of
- Parent
Group List<string>Ids List of Group IDs which are parents of this group.
- Policies List<string>
List of policies attached to the group
- Type string
Type of group
- Alias
Canonical stringId Canonical ID of the Alias
- Alias
Creation stringTime Creation time of the Alias
- Alias
Id string - Alias
Last stringUpdate Time Last update time of the alias
- Alias
Merged []stringFrom Canonical Ids List of canonical IDs merged with this alias
- Alias
Metadata map[string]interface{} Arbitrary metadata
- Alias
Mount stringAccessor - Alias
Mount stringPath Authentication mount path which this alias belongs to
- Alias
Mount stringType Authentication mount type which this alias belongs to
- Alias
Name string - Creation
Time string Creation timestamp of the group
- Data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- Group
Id string - Group
Name string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Update stringTime Last updated time of the group
- Member
Entity []stringIds List of Entity IDs which are members of this group
- Member
Group []stringIds List of Group IDs which are members of this group
- Metadata map[string]interface{}
Arbitrary metadata
- Modify
Index int Modify index of the group
- Namespace
Id string Namespace of which the group is part of
- Parent
Group []stringIds List of Group IDs which are parents of this group.
- Policies []string
List of policies attached to the group
- Type string
Type of group
- alias
Canonical StringId Canonical ID of the Alias
- alias
Creation StringTime Creation time of the Alias
- alias
Id String - alias
Last StringUpdate Time Last update time of the alias
- alias
Merged ListFrom Canonical Ids List of canonical IDs merged with this alias
- alias
Metadata Map Arbitrary metadata
- alias
Mount StringAccessor - alias
Mount StringPath Authentication mount path which this alias belongs to
- alias
Mount StringType Authentication mount type which this alias belongs to
- alias
Name String - creation
Time String Creation timestamp of the group
- data
Json String A string containing the full data payload retrieved from Vault, serialized in JSON format.
- group
Id String - group
Name String - id String
The provider-assigned unique ID for this managed resource.
- last
Update StringTime Last updated time of the group
- member
Entity ListIds List of Entity IDs which are members of this group
- member
Group ListIds List of Group IDs which are members of this group
- metadata
Map
Arbitrary metadata
- modify
Index Integer Modify index of the group
- namespace
Id String Namespace of which the group is part of
- parent
Group ListIds List of Group IDs which are parents of this group.
- policies
List
List of policies attached to the group
- type String
Type of group
- alias
Canonical stringId Canonical ID of the Alias
- alias
Creation stringTime Creation time of the Alias
- alias
Id string - alias
Last stringUpdate Time Last update time of the alias
- alias
Merged string[]From Canonical Ids List of canonical IDs merged with this alias
- alias
Metadata {[key: string]: any} Arbitrary metadata
- alias
Mount stringAccessor - alias
Mount stringPath Authentication mount path which this alias belongs to
- alias
Mount stringType Authentication mount type which this alias belongs to
- alias
Name string - creation
Time string Creation timestamp of the group
- data
Json string A string containing the full data payload retrieved from Vault, serialized in JSON format.
- group
Id string - group
Name string - id string
The provider-assigned unique ID for this managed resource.
- last
Update stringTime Last updated time of the group
- member
Entity string[]Ids List of Entity IDs which are members of this group
- member
Group string[]Ids List of Group IDs which are members of this group
- metadata {[key: string]: any}
Arbitrary metadata
- modify
Index number Modify index of the group
- namespace
Id string Namespace of which the group is part of
- parent
Group string[]Ids List of Group IDs which are parents of this group.
- policies string[]
List of policies attached to the group
- type string
Type of group
- alias_
canonical_ strid Canonical ID of the Alias
- alias_
creation_ strtime Creation time of the Alias
- alias_
id str - alias_
last_ strupdate_ time Last update time of the alias
- alias_
merged_ Sequence[str]from_ canonical_ ids List of canonical IDs merged with this alias
- alias_
metadata Mapping[str, Any] Arbitrary metadata
- alias_
mount_ straccessor - alias_
mount_ strpath Authentication mount path which this alias belongs to
- alias_
mount_ strtype Authentication mount type which this alias belongs to
- alias_
name str - creation_
time str Creation timestamp of the group
- data_
json str A string containing the full data payload retrieved from Vault, serialized in JSON format.
- group_
id str - group_
name str - id str
The provider-assigned unique ID for this managed resource.
- last_
update_ strtime Last updated time of the group
- member_
entity_ Sequence[str]ids List of Entity IDs which are members of this group
- member_
group_ Sequence[str]ids List of Group IDs which are members of this group
- metadata Mapping[str, Any]
Arbitrary metadata
- modify_
index int Modify index of the group
- namespace_
id str Namespace of which the group is part of
- parent_
group_ Sequence[str]ids List of Group IDs which are parents of this group.
- policies Sequence[str]
List of policies attached to the group
- type str
Type of group
- alias
Canonical StringId Canonical ID of the Alias
- alias
Creation StringTime Creation time of the Alias
- alias
Id String - alias
Last StringUpdate Time Last update time of the alias
- alias
Merged ListFrom Canonical Ids List of canonical IDs merged with this alias
- alias
Metadata Map Arbitrary metadata
- alias
Mount StringAccessor - alias
Mount StringPath Authentication mount path which this alias belongs to
- alias
Mount StringType Authentication mount type which this alias belongs to
- alias
Name String - creation
Time String Creation timestamp of the group
- data
Json String A string containing the full data payload retrieved from Vault, serialized in JSON format.
- group
Id String - group
Name String - id String
The provider-assigned unique ID for this managed resource.
- last
Update StringTime Last updated time of the group
- member
Entity ListIds List of Entity IDs which are members of this group
- member
Group ListIds List of Group IDs which are members of this group
- metadata
Map
Arbitrary metadata
- modify
Index Number Modify index of the group
- namespace
Id String Namespace of which the group is part of
- parent
Group ListIds List of Group IDs which are parents of this group.
- policies
List
List of policies attached to the group
- type String
Type of group
Package Details
- Repository
- https://github.com/pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
vault
Terraform Provider.