Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getOrganizationUserGroup
Viewing docs for Aiven v6.59.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aiven

aiven.getOrganizationUserGroup

aiven logo aiven logo
Viewing docs for Aiven v6.59.0
published on Thursday, Sep 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({
    organizationId: "org1a23f456789",
    groupId: "foo",
});

    import pulumi
import pulumi_aiven as aiven

example = aiven.get_organization_user_group(organization_id="org1a23f456789",
    group_id="foo")

    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.GetOrganizationUserGroup(ctx, &aiven.LookupOrganizationUserGroupArgs{
			OrganizationId: "org1a23f456789",
			GroupId:        pulumi.StringRef("foo"),
		}, 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()
    {
        OrganizationId = "org1a23f456789",
        GroupId = "foo",
    });

});

    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.ArrayList;
import java.util.Arrays;
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()
            .organizationId("org1a23f456789")
            .groupId("foo")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aiven:getOrganizationUserGroup
      arguments:
        organizationId: org1a23f456789
        groupId: foo

    pulumi {
  required_providers {
    aiven = {
      source = "pulumi/aiven"
    }
  }
}

data "aiven_getorganizationusergroup" "example" {
  organization_id = "org1a23f456789"
  group_id        = "foo"
}

    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?: InvokeOutputOptions): Output<GetOrganizationUserGroupResult>
    def get_organization_user_group(group_id: Optional[str] = None,
                                name: Optional[str] = None,
                                organization_id: Optional[str] = None,
                                timeouts: Optional[GetOrganizationUserGroupTimeouts] = None,
                                opts: Optional[InvokeOptions] = None) -> GetOrganizationUserGroupResult
def get_organization_user_group_output(group_id: pulumi.Input[Optional[str]] = None,
                                name: pulumi.Input[Optional[str]] = None,
                                organization_id: pulumi.Input[Optional[str]] = None,
                                timeouts: pulumi.Input[Optional[GetOrganizationUserGroupTimeoutsArgs]] = None,
                                opts: Optional[InvokeOutputOptions] = 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 Output<GetOrganizationUserGroupResult> Invoke(GetOrganizationUserGroupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetOrganizationUserGroupResult> getOrganizationUserGroup(GetOrganizationUserGroupArgs args, InvokeOptions options)
public static Output<GetOrganizationUserGroupResult> getOrganizationUserGroup(GetOrganizationUserGroupArgs args, InvokeOptions options)
public static Output<GetOrganizationUserGroupResult> getOrganizationUserGroup(GetOrganizationUserGroupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aiven:index/getOrganizationUserGroup:getOrganizationUserGroup
  arguments:
    # arguments dictionary
    data "aiven_get_organization_user_group" "name" {
    # arguments
}

    The following arguments are supported:

    OrganizationId string
    ID of an organization.
    GroupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    Name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    Timeouts GetOrganizationUserGroupTimeouts
    OrganizationId string
    ID of an organization.
    GroupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    Name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    Timeouts GetOrganizationUserGroupTimeouts
    organization_id string
    ID of an organization.
    group_id string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    timeouts object
    organizationId String
    ID of an organization.
    groupId String
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    name String
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    timeouts GetOrganizationUserGroupTimeouts
    organizationId string
    ID of an organization.
    groupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    timeouts GetOrganizationUserGroupTimeouts
    organization_id str
    ID of an organization.
    group_id str
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    name str
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    timeouts GetOrganizationUserGroupTimeouts
    organizationId String
    ID of an organization.
    groupId String
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    name String
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    timeouts Property Map

    getOrganizationUserGroup Result

    The following output properties are available:

    CreateTime string
    User group creation time.
    Description string
    Description.
    GroupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    Id string
    Resource ID composed as: organization_id/group_id.
    ManagedByScim bool
    Managed By Scim.
    Name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    OrganizationId string
    ID of an organization.
    UpdateTime string
    User group last update time.
    Timeouts GetOrganizationUserGroupTimeouts
    CreateTime string
    User group creation time.
    Description string
    Description.
    GroupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    Id string
    Resource ID composed as: organization_id/group_id.
    ManagedByScim bool
    Managed By Scim.
    Name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    OrganizationId string
    ID of an organization.
    UpdateTime string
    User group last update time.
    Timeouts GetOrganizationUserGroupTimeouts
    create_time string
    User group creation time.
    description string
    Description.
    group_id string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    id string
    Resource ID composed as: organization_id/group_id.
    managed_by_scim bool
    Managed By Scim.
    name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    organization_id string
    ID of an organization.
    update_time string
    User group last update time.
    timeouts object
    createTime String
    User group creation time.
    description String
    Description.
    groupId String
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    id String
    Resource ID composed as: organization_id/group_id.
    managedByScim Boolean
    Managed By Scim.
    name String
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    organizationId String
    ID of an organization.
    updateTime String
    User group last update time.
    timeouts GetOrganizationUserGroupTimeouts
    createTime string
    User group creation time.
    description string
    Description.
    groupId string
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    id string
    Resource ID composed as: organization_id/group_id.
    managedByScim boolean
    Managed By Scim.
    name string
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    organizationId string
    ID of an organization.
    updateTime string
    User group last update time.
    timeouts GetOrganizationUserGroupTimeouts
    create_time str
    User group creation time.
    description str
    Description.
    group_id str
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    id str
    Resource ID composed as: organization_id/group_id.
    managed_by_scim bool
    Managed By Scim.
    name str
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    organization_id str
    ID of an organization.
    update_time str
    User group last update time.
    timeouts GetOrganizationUserGroupTimeouts
    createTime String
    User group creation time.
    description String
    Description.
    groupId String
    ID of the user group. Exactly one of the fields must be specified: groupId or name.
    id String
    Resource ID composed as: organization_id/group_id.
    managedByScim Boolean
    Managed By Scim.
    name String
    User Group Name. Exactly one of the fields must be specified: groupId or name.
    organizationId String
    ID of an organization.
    updateTime String
    User group last update time.
    timeouts Property Map

    Supporting Types

    GetOrganizationUserGroupTimeouts

    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo aiven logo
    Viewing docs for Aiven v6.59.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aiven

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial