1. Packages
  2. Packages
  3. Aiven Provider
  4. API Docs
  5. getOrganizationUserGroupList
Viewing docs for Aiven v6.54.0
published on Thursday, May 21, 2026 by Pulumi
aiven logo
Viewing docs for Aiven v6.54.0
published on Thursday, May 21, 2026 by Pulumi

    List all user groups within an organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const example = aiven.getOrganizationUserGroupList({
        organizationId: "org1a23f456789",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    example = aiven.get_organization_user_group_list(organization_id="org1a23f456789")
    
    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.GetOrganizationUserGroupList(ctx, &aiven.GetOrganizationUserGroupListArgs{
    			OrganizationId: "org1a23f456789",
    		}, 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.GetOrganizationUserGroupList.Invoke(new()
        {
            OrganizationId = "org1a23f456789",
        });
    
    });
    
    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.GetOrganizationUserGroupListArgs;
    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.getOrganizationUserGroupList(GetOrganizationUserGroupListArgs.builder()
                .organizationId("org1a23f456789")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aiven:getOrganizationUserGroupList
          arguments:
            organizationId: org1a23f456789
    
    Example coming soon!
    

    Using getOrganizationUserGroupList

    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 getOrganizationUserGroupList(args: GetOrganizationUserGroupListArgs, opts?: InvokeOptions): Promise<GetOrganizationUserGroupListResult>
    function getOrganizationUserGroupListOutput(args: GetOrganizationUserGroupListOutputArgs, opts?: InvokeOptions): Output<GetOrganizationUserGroupListResult>
    def get_organization_user_group_list(organization_id: Optional[str] = None,
                                         timeouts: Optional[GetOrganizationUserGroupListTimeouts] = None,
                                         user_groups: Optional[Sequence[GetOrganizationUserGroupListUserGroup]] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetOrganizationUserGroupListResult
    def get_organization_user_group_list_output(organization_id: pulumi.Input[Optional[str]] = None,
                                         timeouts: pulumi.Input[Optional[GetOrganizationUserGroupListTimeoutsArgs]] = None,
                                         user_groups: pulumi.Input[Optional[Sequence[pulumi.Input[GetOrganizationUserGroupListUserGroupArgs]]]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationUserGroupListResult]
    func GetOrganizationUserGroupList(ctx *Context, args *GetOrganizationUserGroupListArgs, opts ...InvokeOption) (*GetOrganizationUserGroupListResult, error)
    func GetOrganizationUserGroupListOutput(ctx *Context, args *GetOrganizationUserGroupListOutputArgs, opts ...InvokeOption) GetOrganizationUserGroupListResultOutput

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

    public static class GetOrganizationUserGroupList 
    {
        public static Task<GetOrganizationUserGroupListResult> InvokeAsync(GetOrganizationUserGroupListArgs args, InvokeOptions? opts = null)
        public static Output<GetOrganizationUserGroupListResult> Invoke(GetOrganizationUserGroupListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationUserGroupListResult> getOrganizationUserGroupList(GetOrganizationUserGroupListArgs args, InvokeOptions options)
    public static Output<GetOrganizationUserGroupListResult> getOrganizationUserGroupList(GetOrganizationUserGroupListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aiven:index/getOrganizationUserGroupList:getOrganizationUserGroupList
      arguments:
        # arguments dictionary
    data "aiven_getorganizationusergrouplist" "name" {
        # arguments
    }

    The following arguments are supported:

    organization_id string
    ID of an organization.
    timeouts object
    user_groups list(object)
    User Groups.
    organizationId String
    ID of an organization.
    timeouts Property Map
    userGroups List<Property Map>
    User Groups.

    getOrganizationUserGroupList Result

    The following output properties are available:

    Id string
    Resource ID, equal to organizationId.
    OrganizationId string
    ID of an organization.
    Timeouts GetOrganizationUserGroupListTimeouts
    UserGroups List<GetOrganizationUserGroupListUserGroup>
    User Groups.
    Id string
    Resource ID, equal to organizationId.
    OrganizationId string
    ID of an organization.
    Timeouts GetOrganizationUserGroupListTimeouts
    UserGroups []GetOrganizationUserGroupListUserGroup
    User Groups.
    id string
    Resource ID, equal to organizationId.
    organization_id string
    ID of an organization.
    timeouts object
    user_groups list(object)
    User Groups.
    id String
    Resource ID, equal to organizationId.
    organizationId String
    ID of an organization.
    timeouts GetOrganizationUserGroupListTimeouts
    userGroups List<GetOrganizationUserGroupListUserGroup>
    User Groups.
    id string
    Resource ID, equal to organizationId.
    organizationId string
    ID of an organization.
    timeouts GetOrganizationUserGroupListTimeouts
    userGroups GetOrganizationUserGroupListUserGroup[]
    User Groups.
    id str
    Resource ID, equal to organizationId.
    organization_id str
    ID of an organization.
    timeouts GetOrganizationUserGroupListTimeouts
    user_groups Sequence[GetOrganizationUserGroupListUserGroup]
    User Groups.
    id String
    Resource ID, equal to organizationId.
    organizationId String
    ID of an organization.
    timeouts Property Map
    userGroups List<Property Map>
    User Groups.

    Supporting Types

    GetOrganizationUserGroupListTimeouts

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

    GetOrganizationUserGroupListUserGroup

    CreateTime string
    User group creation time.
    Description string
    Description.
    ManagedByScim bool
    Managed By Scim.
    MemberCount int
    Member Count.
    UpdateTime string
    User group last update time.
    UserGroupId string
    User Group ID.
    UserGroupName string
    User Group Name.
    CreateTime string
    User group creation time.
    Description string
    Description.
    ManagedByScim bool
    Managed By Scim.
    MemberCount int
    Member Count.
    UpdateTime string
    User group last update time.
    UserGroupId string
    User Group ID.
    UserGroupName string
    User Group Name.
    create_time string
    User group creation time.
    description string
    Description.
    managed_by_scim bool
    Managed By Scim.
    member_count number
    Member Count.
    update_time string
    User group last update time.
    user_group_id string
    User Group ID.
    user_group_name string
    User Group Name.
    createTime String
    User group creation time.
    description String
    Description.
    managedByScim Boolean
    Managed By Scim.
    memberCount Integer
    Member Count.
    updateTime String
    User group last update time.
    userGroupId String
    User Group ID.
    userGroupName String
    User Group Name.
    createTime string
    User group creation time.
    description string
    Description.
    managedByScim boolean
    Managed By Scim.
    memberCount number
    Member Count.
    updateTime string
    User group last update time.
    userGroupId string
    User Group ID.
    userGroupName string
    User Group Name.
    create_time str
    User group creation time.
    description str
    Description.
    managed_by_scim bool
    Managed By Scim.
    member_count int
    Member Count.
    update_time str
    User group last update time.
    user_group_id str
    User Group ID.
    user_group_name str
    User Group Name.
    createTime String
    User group creation time.
    description String
    Description.
    managedByScim Boolean
    Managed By Scim.
    memberCount Number
    Member Count.
    updateTime String
    User group last update time.
    userGroupId String
    User Group ID.
    userGroupName String
    User Group Name.

    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.54.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial