1. Packages
  2. Okta
  3. API Docs
  4. group
  5. Owner
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi

okta.group.Owner

Explore with Pulumi AI

okta logo
Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi

    Manages group owner resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = new okta.user.User("test", {
        firstName: "TestAcc",
        lastName: "Smith",
        login: "testAcc-replace_with_uuid@example.com",
        email: "testAcc-replace_with_uuid@example.com",
    });
    const testGroup = new okta.group.Group("test", {name: "testAcc_replace_with_uuid"});
    const testOwner = new okta.group.Owner("test", {
        groupId: testGroup.id,
        idOfGroupOwner: test.id,
        type: "USER",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.user.User("test",
        first_name="TestAcc",
        last_name="Smith",
        login="testAcc-replace_with_uuid@example.com",
        email="testAcc-replace_with_uuid@example.com")
    test_group = okta.group.Group("test", name="testAcc_replace_with_uuid")
    test_owner = okta.group.Owner("test",
        group_id=test_group.id,
        id_of_group_owner=test.id,
        type="USER")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/group"
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/user"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := user.NewUser(ctx, "test", &user.UserArgs{
    			FirstName: pulumi.String("TestAcc"),
    			LastName:  pulumi.String("Smith"),
    			Login:     pulumi.String("testAcc-replace_with_uuid@example.com"),
    			Email:     pulumi.String("testAcc-replace_with_uuid@example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		testGroup, err := group.NewGroup(ctx, "test", &group.GroupArgs{
    			Name: pulumi.String("testAcc_replace_with_uuid"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = group.NewOwner(ctx, "test", &group.OwnerArgs{
    			GroupId:        testGroup.ID(),
    			IdOfGroupOwner: test.ID(),
    			Type:           pulumi.String("USER"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Okta.User.User("test", new()
        {
            FirstName = "TestAcc",
            LastName = "Smith",
            Login = "testAcc-replace_with_uuid@example.com",
            Email = "testAcc-replace_with_uuid@example.com",
        });
    
        var testGroup = new Okta.Group.Group("test", new()
        {
            Name = "testAcc_replace_with_uuid",
        });
    
        var testOwner = new Okta.Group.Owner("test", new()
        {
            GroupId = testGroup.Id,
            IdOfGroupOwner = test.Id,
            Type = "USER",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.user.User;
    import com.pulumi.okta.user.UserArgs;
    import com.pulumi.okta.group.Group;
    import com.pulumi.okta.group.GroupArgs;
    import com.pulumi.okta.group.Owner;
    import com.pulumi.okta.group.OwnerArgs;
    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 test = new User("test", UserArgs.builder()
                .firstName("TestAcc")
                .lastName("Smith")
                .login("testAcc-replace_with_uuid@example.com")
                .email("testAcc-replace_with_uuid@example.com")
                .build());
    
            var testGroup = new Group("testGroup", GroupArgs.builder()
                .name("testAcc_replace_with_uuid")
                .build());
    
            var testOwner = new Owner("testOwner", OwnerArgs.builder()
                .groupId(testGroup.id())
                .idOfGroupOwner(test.id())
                .type("USER")
                .build());
    
        }
    }
    
    resources:
      test:
        type: okta:user:User
        properties:
          firstName: TestAcc
          lastName: Smith
          login: testAcc-replace_with_uuid@example.com
          email: testAcc-replace_with_uuid@example.com
      testGroup:
        type: okta:group:Group
        name: test
        properties:
          name: testAcc_replace_with_uuid
      testOwner:
        type: okta:group:Owner
        name: test
        properties:
          groupId: ${testGroup.id}
          idOfGroupOwner: ${test.id}
          type: USER
    

    Create Owner Resource

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

    Constructor syntax

    new Owner(name: string, args: OwnerArgs, opts?: CustomResourceOptions);
    @overload
    def Owner(resource_name: str,
              args: OwnerArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Owner(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              group_id: Optional[str] = None,
              id_of_group_owner: Optional[str] = None,
              type: Optional[str] = None)
    func NewOwner(ctx *Context, name string, args OwnerArgs, opts ...ResourceOption) (*Owner, error)
    public Owner(string name, OwnerArgs args, CustomResourceOptions? opts = null)
    public Owner(String name, OwnerArgs args)
    public Owner(String name, OwnerArgs args, CustomResourceOptions options)
    
    type: okta:group:Owner
    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 OwnerArgs
    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 OwnerArgs
    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 OwnerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OwnerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OwnerArgs
    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 ownerResource = new Okta.Group.Owner("ownerResource", new()
    {
        GroupId = "string",
        IdOfGroupOwner = "string",
        Type = "string",
    });
    
    example, err := group.NewOwner(ctx, "ownerResource", &group.OwnerArgs{
    	GroupId:        pulumi.String("string"),
    	IdOfGroupOwner: pulumi.String("string"),
    	Type:           pulumi.String("string"),
    })
    
    var ownerResource = new Owner("ownerResource", OwnerArgs.builder()
        .groupId("string")
        .idOfGroupOwner("string")
        .type("string")
        .build());
    
    owner_resource = okta.group.Owner("ownerResource",
        group_id="string",
        id_of_group_owner="string",
        type="string")
    
    const ownerResource = new okta.group.Owner("ownerResource", {
        groupId: "string",
        idOfGroupOwner: "string",
        type: "string",
    });
    
    type: okta:group:Owner
    properties:
        groupId: string
        idOfGroupOwner: string
        type: string
    

    Owner Resource Properties

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

    Inputs

    The Owner resource accepts the following input properties:

    GroupId string
    The id of the group
    IdOfGroupOwner string
    The user id of the group owner
    Type string
    The entity type of the owner. Enum: "GROUP" "USER"
    GroupId string
    The id of the group
    IdOfGroupOwner string
    The user id of the group owner
    Type string
    The entity type of the owner. Enum: "GROUP" "USER"
    groupId String
    The id of the group
    idOfGroupOwner String
    The user id of the group owner
    type String
    The entity type of the owner. Enum: "GROUP" "USER"
    groupId string
    The id of the group
    idOfGroupOwner string
    The user id of the group owner
    type string
    The entity type of the owner. Enum: "GROUP" "USER"
    group_id str
    The id of the group
    id_of_group_owner str
    The user id of the group owner
    type str
    The entity type of the owner. Enum: "GROUP" "USER"
    groupId String
    The id of the group
    idOfGroupOwner String
    The user id of the group owner
    type String
    The entity type of the owner. Enum: "GROUP" "USER"

    Outputs

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

    DisplayName string
    The display name of the group owner
    Id string
    The provider-assigned unique ID for this managed resource.
    OriginId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    OriginType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    Resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    DisplayName string
    The display name of the group owner
    Id string
    The provider-assigned unique ID for this managed resource.
    OriginId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    OriginType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    Resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    displayName String
    The display name of the group owner
    id String
    The provider-assigned unique ID for this managed resource.
    originId String
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType String
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved Boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    displayName string
    The display name of the group owner
    id string
    The provider-assigned unique ID for this managed resource.
    originId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    display_name str
    The display name of the group owner
    id str
    The provider-assigned unique ID for this managed resource.
    origin_id str
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    origin_type str
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    displayName String
    The display name of the group owner
    id String
    The provider-assigned unique ID for this managed resource.
    originId String
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType String
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved Boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.

    Look up Existing Owner Resource

    Get an existing Owner 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?: OwnerState, opts?: CustomResourceOptions): Owner
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            group_id: Optional[str] = None,
            id_of_group_owner: Optional[str] = None,
            origin_id: Optional[str] = None,
            origin_type: Optional[str] = None,
            resolved: Optional[bool] = None,
            type: Optional[str] = None) -> Owner
    func GetOwner(ctx *Context, name string, id IDInput, state *OwnerState, opts ...ResourceOption) (*Owner, error)
    public static Owner Get(string name, Input<string> id, OwnerState? state, CustomResourceOptions? opts = null)
    public static Owner get(String name, Output<String> id, OwnerState 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:
    DisplayName string
    The display name of the group owner
    GroupId string
    The id of the group
    IdOfGroupOwner string
    The user id of the group owner
    OriginId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    OriginType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    Resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    Type string
    The entity type of the owner. Enum: "GROUP" "USER"
    DisplayName string
    The display name of the group owner
    GroupId string
    The id of the group
    IdOfGroupOwner string
    The user id of the group owner
    OriginId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    OriginType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    Resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    Type string
    The entity type of the owner. Enum: "GROUP" "USER"
    displayName String
    The display name of the group owner
    groupId String
    The id of the group
    idOfGroupOwner String
    The user id of the group owner
    originId String
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType String
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved Boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    type String
    The entity type of the owner. Enum: "GROUP" "USER"
    displayName string
    The display name of the group owner
    groupId string
    The id of the group
    idOfGroupOwner string
    The user id of the group owner
    originId string
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType string
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    type string
    The entity type of the owner. Enum: "GROUP" "USER"
    display_name str
    The display name of the group owner
    group_id str
    The id of the group
    id_of_group_owner str
    The user id of the group owner
    origin_id str
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    origin_type str
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved bool
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    type str
    The entity type of the owner. Enum: "GROUP" "USER"
    displayName String
    The display name of the group owner
    groupId String
    The id of the group
    idOfGroupOwner String
    The user id of the group owner
    originId String
    The ID of the app instance if the originType is APPLICATION. This value is NULL if originType is OKTA_DIRECTORY.
    originType String
    The source where group ownership is managed. Enum: "APPLICATION" "OKTA_DIRECTORY"
    resolved Boolean
    If originType is APPLICATION, this parameter is set to FALSE until the owner's originId is reconciled with an associated Okta ID.
    type String
    The entity type of the owner. Enum: "GROUP" "USER"

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.0 published on Tuesday, Sep 17, 2024 by Pulumi