1. Packages
  2. Aiven Provider
  3. API Docs
  4. getOrganizationUserGroup
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.getOrganizationUserGroup

aiven logo
Viewing docs for Aiven v6.51.0
published on Tuesday, Mar 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

    Gets information about an existing user group in an organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const example = aiven.getOrganizationUserGroup({
    name: "Example group",
    organizationId: main.id,
});

    import pulumi
import pulumi_aiven as aiven

example = aiven.get_organization_user_group(name="Example group",
    organization_id=main["id"])

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupOrganizationUserGroup(ctx, &aiven.LookupOrganizationUserGroupArgs{
			Name:           "Example group",
			OrganizationId: main.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var example = Aiven.GetOrganizationUserGroup.Invoke(new()
    {
        Name = "Example group",
        OrganizationId = main.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetOrganizationUserGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AivenFunctions.getOrganizationUserGroup(GetOrganizationUserGroupArgs.builder()
            .name("Example group")
            .organizationId(main.id())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aiven:getOrganizationUserGroup
      arguments:
        name: Example group
        organizationId: ${main.id}

    Using getOrganizationUserGroup

    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 getOrganizationUserGroup(args: GetOrganizationUserGroupArgs, opts?: InvokeOptions): Promise<GetOrganizationUserGroupResult>
function getOrganizationUserGroupOutput(args: GetOrganizationUserGroupOutputArgs, opts?: InvokeOptions): Output<GetOrganizationUserGroupResult>
    def get_organization_user_group(name: Optional[str] = None,
                                organization_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetOrganizationUserGroupResult
def get_organization_user_group_output(name: Optional[pulumi.Input[str]] = None,
                                organization_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationUserGroupResult]
    func LookupOrganizationUserGroup(ctx *Context, args *LookupOrganizationUserGroupArgs, opts ...InvokeOption) (*LookupOrganizationUserGroupResult, error)
func LookupOrganizationUserGroupOutput(ctx *Context, args *LookupOrganizationUserGroupOutputArgs, opts ...InvokeOption) LookupOrganizationUserGroupResultOutput

    > Note: This function is named LookupOrganizationUserGroup in the Go SDK.

    public static class GetOrganizationUserGroup 
{
    public static Task<GetOrganizationUserGroupResult> InvokeAsync(GetOrganizationUserGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationUserGroupResult> Invoke(GetOrganizationUserGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrganizationUserGroupResult> getOrganizationUserGroup(GetOrganizationUserGroupArgs args, InvokeOptions options)
public static Output<GetOrganizationUserGroupResult> getOrganizationUserGroup(GetOrganizationUserGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aiven:index/getOrganizationUserGroup:getOrganizationUserGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    name string
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    name str
    The name of the user group. Changing this property forces recreation of the resource.
    organization_id str
    The ID of the organization. Changing this property forces recreation of the resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.

    getOrganizationUserGroup Result

    The following output properties are available:

    CreateTime string
    Time of creation.
    Description string
    The description of the user group. Changing this property forces recreation of the resource.
    GroupId string
    The ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    UpdateTime string
    Time of last update.
    CreateTime string
    Time of creation.
    Description string
    The description of the user group. Changing this property forces recreation of the resource.
    GroupId string
    The ID of the user group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the user group. Changing this property forces recreation of the resource.
    OrganizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    UpdateTime string
    Time of last update.
    createTime String
    Time of creation.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    groupId String
    The ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime String
    Time of last update.
    createTime string
    Time of creation.
    description string
    The description of the user group. Changing this property forces recreation of the resource.
    groupId string
    The ID of the user group.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId string
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime string
    Time of last update.
    create_time str
    Time of creation.
    description str
    The description of the user group. Changing this property forces recreation of the resource.
    group_id str
    The ID of the user group.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the user group. Changing this property forces recreation of the resource.
    organization_id str
    The ID of the organization. Changing this property forces recreation of the resource.
    update_time str
    Time of last update.
    createTime String
    Time of creation.
    description String
    The description of the user group. Changing this property forces recreation of the resource.
    groupId String
    The ID of the user group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the user group. Changing this property forces recreation of the resource.
    organizationId String
    The ID of the organization. Changing this property forces recreation of the resource.
    updateTime String
    Time of last update.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Viewing docs for Aiven v6.51.0
    published on Tuesday, Mar 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven
      Try Pulumi Cloud free. Your team will thank you.