Docs Home
Keycloak v5.3.5 published on Wednesday, Oct 16, 2024 by Pulumi
keycloak.getGroup
Explore with Pulumi AI
# keycloak.Group data source
This data source can be used to fetch properties of a Keycloak group for
usage with other resources, such as keycloak.GroupRoles.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
realm:
type: keycloak:Realm
properties:
realm: my-realm
enabled: true
groupRoles:
type: keycloak:GroupRoles
name: group_roles
properties:
realmId: ${realm.id}
groupId: ${group.id}
roles:
- ${offlineAccess.id}
variables:
offlineAccess:
fn::invoke:
Function: keycloak:getRole
Arguments:
realmId: ${realm.id}
name: offline_access
group:
fn::invoke:
Function: keycloak:getGroup
Arguments:
realmId: ${realm.id}
name: group
Argument Reference
The following arguments are supported:
realm_id- (Required) The realm this group exists within.name- (Required) The name of the group
Attributes Reference
In addition to the arguments listed above, the following computed attributes are exported:
id- The unique ID of the group, which can be used as an argument to other resources supported by this provider.
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(name: Optional[str] = None,
realm_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(name: Optional[pulumi.Input[str]] = None,
realm_id: 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: keycloak:index/getGroup:getGroup
arguments:
# arguments dictionaryThe following arguments are supported:
getGroup Result
The following output properties are available:
Package Details
- Repository
- Keycloak pulumi/pulumi-keycloak
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
keycloakTerraform Provider.