1. Packages
  2. Aiven Provider
  3. API Docs
  4. OrganizationApplicationUser
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

aiven.OrganizationApplicationUser

Explore with Pulumi AI

aiven logo
Aiven v6.28.0 published on Friday, Nov 15, 2024 by Pulumi

    Creates and manages an organization application user. Application users can be used for programmatic access to the platform.

    You give application users access to projects by adding them as members of a group using aiven.OrganizationUserGroupMember and assigning the group to a project with aiven.OrganizationGroupProject. You can give an application user access to all resources in your organization by setting is_super_admin = true .

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aiven from "@pulumi/aiven";
    
    const tfUser = new aiven.OrganizationApplicationUser("tf_user", {
        organizationId: main.id,
        name: "app-terraform",
    });
    
    import pulumi
    import pulumi_aiven as aiven
    
    tf_user = aiven.OrganizationApplicationUser("tf_user",
        organization_id=main["id"],
        name="app-terraform")
    
    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.NewOrganizationApplicationUser(ctx, "tf_user", &aiven.OrganizationApplicationUserArgs{
    			OrganizationId: pulumi.Any(main.Id),
    			Name:           pulumi.String("app-terraform"),
    		})
    		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 tfUser = new Aiven.OrganizationApplicationUser("tf_user", new()
        {
            OrganizationId = main.Id,
            Name = "app-terraform",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aiven.OrganizationApplicationUser;
    import com.pulumi.aiven.OrganizationApplicationUserArgs;
    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) {
            var tfUser = new OrganizationApplicationUser("tfUser", OrganizationApplicationUserArgs.builder()
                .organizationId(main.id())
                .name("app-terraform")
                .build());
    
        }
    }
    
    resources:
      tfUser:
        type: aiven:OrganizationApplicationUser
        name: tf_user
        properties:
          organizationId: ${main.id}
          name: app-terraform
    

    Create OrganizationApplicationUser Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrganizationApplicationUser(name: string, args: OrganizationApplicationUserArgs, opts?: CustomResourceOptions);
    @overload
    def OrganizationApplicationUser(resource_name: str,
                                    args: OrganizationApplicationUserArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def OrganizationApplicationUser(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    organization_id: Optional[str] = None,
                                    is_super_admin: Optional[bool] = None,
                                    name: Optional[str] = None)
    func NewOrganizationApplicationUser(ctx *Context, name string, args OrganizationApplicationUserArgs, opts ...ResourceOption) (*OrganizationApplicationUser, error)
    public OrganizationApplicationUser(string name, OrganizationApplicationUserArgs args, CustomResourceOptions? opts = null)
    public OrganizationApplicationUser(String name, OrganizationApplicationUserArgs args)
    public OrganizationApplicationUser(String name, OrganizationApplicationUserArgs args, CustomResourceOptions options)
    
    type: aiven:OrganizationApplicationUser
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args OrganizationApplicationUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrganizationApplicationUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrganizationApplicationUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationApplicationUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationApplicationUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var organizationApplicationUserResource = new Aiven.OrganizationApplicationUser("organizationApplicationUserResource", new()
    {
        OrganizationId = "string",
        IsSuperAdmin = false,
        Name = "string",
    });
    
    example, err := aiven.NewOrganizationApplicationUser(ctx, "organizationApplicationUserResource", &aiven.OrganizationApplicationUserArgs{
    	OrganizationId: pulumi.String("string"),
    	IsSuperAdmin:   pulumi.Bool(false),
    	Name:           pulumi.String("string"),
    })
    
    var organizationApplicationUserResource = new OrganizationApplicationUser("organizationApplicationUserResource", OrganizationApplicationUserArgs.builder()
        .organizationId("string")
        .isSuperAdmin(false)
        .name("string")
        .build());
    
    organization_application_user_resource = aiven.OrganizationApplicationUser("organizationApplicationUserResource",
        organization_id="string",
        is_super_admin=False,
        name="string")
    
    const organizationApplicationUserResource = new aiven.OrganizationApplicationUser("organizationApplicationUserResource", {
        organizationId: "string",
        isSuperAdmin: false,
        name: "string",
    });
    
    type: aiven:OrganizationApplicationUser
    properties:
        isSuperAdmin: false
        name: string
        organizationId: string
    

    OrganizationApplicationUser Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrganizationApplicationUser resource accepts the following input properties:

    OrganizationId string
    The ID of the organization the application user belongs to.
    IsSuperAdmin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    Name string
    Name of the application user.
    OrganizationId string
    The ID of the organization the application user belongs to.
    IsSuperAdmin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    Name string
    Name of the application user.
    organizationId String
    The ID of the organization the application user belongs to.
    isSuperAdmin Boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name String
    Name of the application user.
    organizationId string
    The ID of the organization the application user belongs to.
    isSuperAdmin boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name string
    Name of the application user.
    organization_id str
    The ID of the organization the application user belongs to.
    is_super_admin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name str
    Name of the application user.
    organizationId String
    The ID of the organization the application user belongs to.
    isSuperAdmin Boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name String
    Name of the application user.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationApplicationUser resource produces the following output properties:

    Email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    The ID of the application user.
    Email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    Id string
    The provider-assigned unique ID for this managed resource.
    UserId string
    The ID of the application user.
    email String
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    The ID of the application user.
    email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    id string
    The provider-assigned unique ID for this managed resource.
    userId string
    The ID of the application user.
    email str
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    id str
    The provider-assigned unique ID for this managed resource.
    user_id str
    The ID of the application user.
    email String
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    id String
    The provider-assigned unique ID for this managed resource.
    userId String
    The ID of the application user.

    Look up Existing OrganizationApplicationUser Resource

    Get an existing OrganizationApplicationUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrganizationApplicationUserState, opts?: CustomResourceOptions): OrganizationApplicationUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            email: Optional[str] = None,
            is_super_admin: Optional[bool] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            user_id: Optional[str] = None) -> OrganizationApplicationUser
    func GetOrganizationApplicationUser(ctx *Context, name string, id IDInput, state *OrganizationApplicationUserState, opts ...ResourceOption) (*OrganizationApplicationUser, error)
    public static OrganizationApplicationUser Get(string name, Input<string> id, OrganizationApplicationUserState? state, CustomResourceOptions? opts = null)
    public static OrganizationApplicationUser get(String name, Output<String> id, OrganizationApplicationUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    IsSuperAdmin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    Name string
    Name of the application user.
    OrganizationId string
    The ID of the organization the application user belongs to.
    UserId string
    The ID of the application user.
    Email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    IsSuperAdmin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    Name string
    Name of the application user.
    OrganizationId string
    The ID of the organization the application user belongs to.
    UserId string
    The ID of the application user.
    email String
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    isSuperAdmin Boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name String
    Name of the application user.
    organizationId String
    The ID of the organization the application user belongs to.
    userId String
    The ID of the application user.
    email string
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    isSuperAdmin boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name string
    Name of the application user.
    organizationId string
    The ID of the organization the application user belongs to.
    userId string
    The ID of the application user.
    email str
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    is_super_admin bool
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name str
    Name of the application user.
    organization_id str
    The ID of the organization the application user belongs to.
    user_id str
    The ID of the application user.
    email String
    An email address automatically generated by Aiven to help identify the application user. No notifications are sent to this email.
    isSuperAdmin Boolean
    Makes the application user a super admin. The super admin role has full access to an organization, its billing and settings, and all its organizational units, projects, and services.
    name String
    Name of the application user.
    organizationId String
    The ID of the organization the application user belongs to.
    userId String
    The ID of the application user.

    Import

    $ pulumi import aiven:index/organizationApplicationUser:OrganizationApplicationUser example ORGANIZATION_ID/USER_ID
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.28.0 published on Friday, Nov 15, 2024 by Pulumi