1. Packages
  2. Airbyte Provider
  3. API Docs
  4. Permission
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.Permission

Explore with Pulumi AI

Permission Resource

Example Usage

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

const myPermission = new airbyte.Permission("myPermission", {
    organizationId: "d109e1f3-ec33-4ca2-89ba-9b654ec67eae",
    permissionType: "organization_reader",
    userId: "c3231461-7373-4a98-aed1-9a79ad305d18",
    workspaceId: "8b030f86-f6a4-490a-92a7-a996c2b017ea",
});
Copy
import pulumi
import pulumi_airbyte as airbyte

my_permission = airbyte.Permission("myPermission",
    organization_id="d109e1f3-ec33-4ca2-89ba-9b654ec67eae",
    permission_type="organization_reader",
    user_id="c3231461-7373-4a98-aed1-9a79ad305d18",
    workspace_id="8b030f86-f6a4-490a-92a7-a996c2b017ea")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/airbyte/airbyte"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := airbyte.NewPermission(ctx, "myPermission", &airbyte.PermissionArgs{
			OrganizationId: pulumi.String("d109e1f3-ec33-4ca2-89ba-9b654ec67eae"),
			PermissionType: pulumi.String("organization_reader"),
			UserId:         pulumi.String("c3231461-7373-4a98-aed1-9a79ad305d18"),
			WorkspaceId:    pulumi.String("8b030f86-f6a4-490a-92a7-a996c2b017ea"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Airbyte = Pulumi.Airbyte;

return await Deployment.RunAsync(() => 
{
    var myPermission = new Airbyte.Permission("myPermission", new()
    {
        OrganizationId = "d109e1f3-ec33-4ca2-89ba-9b654ec67eae",
        PermissionType = "organization_reader",
        UserId = "c3231461-7373-4a98-aed1-9a79ad305d18",
        WorkspaceId = "8b030f86-f6a4-490a-92a7-a996c2b017ea",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.Permission;
import com.pulumi.airbyte.PermissionArgs;
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 myPermission = new Permission("myPermission", PermissionArgs.builder()
            .organizationId("d109e1f3-ec33-4ca2-89ba-9b654ec67eae")
            .permissionType("organization_reader")
            .userId("c3231461-7373-4a98-aed1-9a79ad305d18")
            .workspaceId("8b030f86-f6a4-490a-92a7-a996c2b017ea")
            .build());

    }
}
Copy
resources:
  myPermission:
    type: airbyte:Permission
    properties:
      organizationId: d109e1f3-ec33-4ca2-89ba-9b654ec67eae
      permissionType: organization_reader
      userId: c3231461-7373-4a98-aed1-9a79ad305d18
      workspaceId: 8b030f86-f6a4-490a-92a7-a996c2b017ea
Copy

Create Permission Resource

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

Constructor syntax

new Permission(name: string, args: PermissionArgs, opts?: CustomResourceOptions);
@overload
def Permission(resource_name: str,
               args: PermissionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Permission(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               permission_type: Optional[str] = None,
               user_id: Optional[str] = None,
               organization_id: Optional[str] = None,
               workspace_id: Optional[str] = None)
func NewPermission(ctx *Context, name string, args PermissionArgs, opts ...ResourceOption) (*Permission, error)
public Permission(string name, PermissionArgs args, CustomResourceOptions? opts = null)
public Permission(String name, PermissionArgs args)
public Permission(String name, PermissionArgs args, CustomResourceOptions options)
type: airbyte:Permission
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PermissionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PermissionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PermissionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PermissionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PermissionArgs
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 permissionResource = new Airbyte.Permission("permissionResource", new()
{
    PermissionType = "string",
    UserId = "string",
    OrganizationId = "string",
    WorkspaceId = "string",
});
Copy
example, err := airbyte.NewPermission(ctx, "permissionResource", &airbyte.PermissionArgs{
PermissionType: pulumi.String("string"),
UserId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
WorkspaceId: pulumi.String("string"),
})
Copy
var permissionResource = new Permission("permissionResource", PermissionArgs.builder()
    .permissionType("string")
    .userId("string")
    .organizationId("string")
    .workspaceId("string")
    .build());
Copy
permission_resource = airbyte.Permission("permissionResource",
    permission_type="string",
    user_id="string",
    organization_id="string",
    workspace_id="string")
Copy
const permissionResource = new airbyte.Permission("permissionResource", {
    permissionType: "string",
    userId: "string",
    organizationId: "string",
    workspaceId: "string",
});
Copy
type: airbyte:Permission
properties:
    organizationId: string
    permissionType: string
    userId: string
    workspaceId: string
Copy

Permission 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 Permission resource accepts the following input properties:

PermissionType This property is required. string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
UserId This property is required. string
Internal Airbyte user ID. Requires replacement if changed.
OrganizationId string
Requires replacement if changed.
WorkspaceId string
Requires replacement if changed.
PermissionType This property is required. string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
UserId This property is required. string
Internal Airbyte user ID. Requires replacement if changed.
OrganizationId string
Requires replacement if changed.
WorkspaceId string
Requires replacement if changed.
permissionType This property is required. String
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId This property is required. String
Internal Airbyte user ID. Requires replacement if changed.
organizationId String
Requires replacement if changed.
workspaceId String
Requires replacement if changed.
permissionType This property is required. string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId This property is required. string
Internal Airbyte user ID. Requires replacement if changed.
organizationId string
Requires replacement if changed.
workspaceId string
Requires replacement if changed.
permission_type This property is required. str
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
user_id This property is required. str
Internal Airbyte user ID. Requires replacement if changed.
organization_id str
Requires replacement if changed.
workspace_id str
Requires replacement if changed.
permissionType This property is required. String
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId This property is required. String
Internal Airbyte user ID. Requires replacement if changed.
organizationId String
Requires replacement if changed.
workspaceId String
Requires replacement if changed.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
PermissionId string
Id string
The provider-assigned unique ID for this managed resource.
PermissionId string
id String
The provider-assigned unique ID for this managed resource.
permissionId String
id string
The provider-assigned unique ID for this managed resource.
permissionId string
id str
The provider-assigned unique ID for this managed resource.
permission_id str
id String
The provider-assigned unique ID for this managed resource.
permissionId String

Look up Existing Permission Resource

Get an existing Permission 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?: PermissionState, opts?: CustomResourceOptions): Permission
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        organization_id: Optional[str] = None,
        permission_id: Optional[str] = None,
        permission_type: Optional[str] = None,
        user_id: Optional[str] = None,
        workspace_id: Optional[str] = None) -> Permission
func GetPermission(ctx *Context, name string, id IDInput, state *PermissionState, opts ...ResourceOption) (*Permission, error)
public static Permission Get(string name, Input<string> id, PermissionState? state, CustomResourceOptions? opts = null)
public static Permission get(String name, Output<String> id, PermissionState state, CustomResourceOptions options)
resources:  _:    type: airbyte:Permission    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
OrganizationId string
Requires replacement if changed.
PermissionId string
PermissionType string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
UserId string
Internal Airbyte user ID. Requires replacement if changed.
WorkspaceId string
Requires replacement if changed.
OrganizationId string
Requires replacement if changed.
PermissionId string
PermissionType string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
UserId string
Internal Airbyte user ID. Requires replacement if changed.
WorkspaceId string
Requires replacement if changed.
organizationId String
Requires replacement if changed.
permissionId String
permissionType String
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId String
Internal Airbyte user ID. Requires replacement if changed.
workspaceId String
Requires replacement if changed.
organizationId string
Requires replacement if changed.
permissionId string
permissionType string
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId string
Internal Airbyte user ID. Requires replacement if changed.
workspaceId string
Requires replacement if changed.
organization_id str
Requires replacement if changed.
permission_id str
permission_type str
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
user_id str
Internal Airbyte user ID. Requires replacement if changed.
workspace_id str
Requires replacement if changed.
organizationId String
Requires replacement if changed.
permissionId String
permissionType String
Subset of PermissionType (removing instance_admin), could be used in public-api. must be one of ["organizationadmin", "organizationeditor", "organizationrunner", "organizationreader", "organizationmember", "workspaceadmin", "workspaceeditor", "workspacerunner", "workspace_reader"]
userId String
Internal Airbyte user ID. Requires replacement if changed.
workspaceId String
Requires replacement if changed.

Import

$ pulumi import airbyte:index/permission:Permission my_airbyte_permission ""
Copy

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

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.