1. Docs
  2. Reference
  3. API
  4. Keycloak
  5. GetGroup

GetGroup

# 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.

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

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function  get_group(name=None, realm_id=None, opts=None)
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)

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

public static class GetGroup {
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
RealmId string
Name string
RealmId string
name string
realmId string
name str
realm_id str

GetGroup Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Name string
RealmId string
Id string

The provider-assigned unique ID for this managed resource.

Name string
RealmId string
id string

The provider-assigned unique ID for this managed resource.

name string
realmId string
id str

The provider-assigned unique ID for this managed resource.

name str
realm_id str

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.