Okta v3.21.0, Mar 15 23

okta.app.GroupAssignment

Import

An application group assignment can be imported via the app_id and the group_id.

 $ pulumi import okta:app/groupAssignment:GroupAssignment example &#60;app_id&#62;/&#60;group_id&#62;

Create GroupAssignment Resource

new GroupAssignment(name: string, args: GroupAssignmentArgs, opts?: CustomResourceOptions);

@overload
def GroupAssignment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    app_id: Optional[str] = None,
                    group_id: Optional[str] = None,
                    priority: Optional[int] = None,
                    profile: Optional[str] = None,
                    retain_assignment: Optional[bool] = None)
@overload
def GroupAssignment(resource_name: str,
                    args: GroupAssignmentArgs,
                    opts: Optional[ResourceOptions] = None)

func NewGroupAssignment(ctx *Context, name string, args GroupAssignmentArgs, opts ...ResourceOption) (*GroupAssignment, error)

public GroupAssignment(string name, GroupAssignmentArgs args, CustomResourceOptions? opts = null)

public GroupAssignment(String name, GroupAssignmentArgs args)
public GroupAssignment(String name, GroupAssignmentArgs args, CustomResourceOptions options)

type: okta:app:GroupAssignment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupAssignmentArgs: 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 GroupAssignmentArgs: 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 GroupAssignmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupAssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GroupAssignmentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

AppId string: The ID of the application to assign a group to.
GroupId string: The ID of the group to assign the app to.
Priority int: Priority of group assignment.
Profile string: JSON document containing application profile
RetainAssignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

AppId string: The ID of the application to assign a group to.
GroupId string: The ID of the group to assign the app to.
Priority int: Priority of group assignment.
Profile string: JSON document containing application profile
RetainAssignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId String: The ID of the application to assign a group to.
groupId String: The ID of the group to assign the app to.
priority Integer: Priority of group assignment.
profile String: JSON document containing application profile
retainAssignment Boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId string: The ID of the application to assign a group to.
groupId string: The ID of the group to assign the app to.
priority number: Priority of group assignment.
profile string: JSON document containing application profile
retainAssignment boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

app_id str: The ID of the application to assign a group to.
group_id str: The ID of the group to assign the app to.
priority int: Priority of group assignment.
profile str: JSON document containing application profile
retain_assignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId String: The ID of the application to assign a group to.
groupId String: The ID of the group to assign the app to.
priority Number: Priority of group assignment.
profile String: JSON document containing application profile
retainAssignment Boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing GroupAssignment Resource

Get an existing GroupAssignment 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?: GroupAssignmentState, opts?: CustomResourceOptions): GroupAssignment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        group_id: Optional[str] = None,
        priority: Optional[int] = None,
        profile: Optional[str] = None,
        retain_assignment: Optional[bool] = None) -> GroupAssignment

func GetGroupAssignment(ctx *Context, name string, id IDInput, state *GroupAssignmentState, opts ...ResourceOption) (*GroupAssignment, error)

public static GroupAssignment Get(string name, Input<string> id, GroupAssignmentState? state, CustomResourceOptions? opts = null)

public static GroupAssignment get(String name, Output<String> id, GroupAssignmentState 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:

AppId string: The ID of the application to assign a group to.
GroupId string: The ID of the group to assign the app to.
Priority int: Priority of group assignment.
Profile string: JSON document containing application profile
RetainAssignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

AppId string: The ID of the application to assign a group to.
GroupId string: The ID of the group to assign the app to.
Priority int: Priority of group assignment.
Profile string: JSON document containing application profile
RetainAssignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId String: The ID of the application to assign a group to.
groupId String: The ID of the group to assign the app to.
priority Integer: Priority of group assignment.
profile String: JSON document containing application profile
retainAssignment Boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId string: The ID of the application to assign a group to.
groupId string: The ID of the group to assign the app to.
priority number: Priority of group assignment.
profile string: JSON document containing application profile
retainAssignment boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

app_id str: The ID of the application to assign a group to.
group_id str: The ID of the group to assign the app to.
priority int: Priority of group assignment.
profile str: JSON document containing application profile
retain_assignment bool: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

appId String: The ID of the application to assign a group to.
groupId String: The ID of the group to assign the app to.
priority Number: Priority of group assignment.
profile String: JSON document containing application profile
retainAssignment Boolean: Retain the group assignment on destroy. If set to true, the resource will be removed from state but not from the Okta app.

Package Details

Repository: Okta pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.