1. Packages
  2. Okta
  3. API Docs
  4. AdminRoleCustomAssignments
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

okta.AdminRoleCustomAssignments

Explore with Pulumi AI

okta logo
Okta v4.8.0 published on Saturday, Mar 2, 2024 by Pulumi

    This resource allows the assignment and unassignment of Custom Roles. The members field supports these type of resources:

    • Groups
    • Users

    NOTE: This an Early Access feature.

    Create AdminRoleCustomAssignments Resource

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

    Constructor syntax

    new AdminRoleCustomAssignments(name: string, args: AdminRoleCustomAssignmentsArgs, opts?: CustomResourceOptions);
    @overload
    def AdminRoleCustomAssignments(resource_name: str,
                                   args: AdminRoleCustomAssignmentsArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AdminRoleCustomAssignments(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   custom_role_id: Optional[str] = None,
                                   resource_set_id: Optional[str] = None,
                                   members: Optional[Sequence[str]] = None)
    func NewAdminRoleCustomAssignments(ctx *Context, name string, args AdminRoleCustomAssignmentsArgs, opts ...ResourceOption) (*AdminRoleCustomAssignments, error)
    public AdminRoleCustomAssignments(string name, AdminRoleCustomAssignmentsArgs args, CustomResourceOptions? opts = null)
    public AdminRoleCustomAssignments(String name, AdminRoleCustomAssignmentsArgs args)
    public AdminRoleCustomAssignments(String name, AdminRoleCustomAssignmentsArgs args, CustomResourceOptions options)
    
    type: okta:AdminRoleCustomAssignments
    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 AdminRoleCustomAssignmentsArgs
    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 AdminRoleCustomAssignmentsArgs
    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 AdminRoleCustomAssignmentsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AdminRoleCustomAssignmentsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AdminRoleCustomAssignmentsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var adminRoleCustomAssignmentsResource = new Okta.AdminRoleCustomAssignments("adminRoleCustomAssignmentsResource", new()
    {
        CustomRoleId = "string",
        ResourceSetId = "string",
        Members = new[]
        {
            "string",
        },
    });
    
    example, err := okta.NewAdminRoleCustomAssignments(ctx, "adminRoleCustomAssignmentsResource", &okta.AdminRoleCustomAssignmentsArgs{
    	CustomRoleId:  pulumi.String("string"),
    	ResourceSetId: pulumi.String("string"),
    	Members: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var adminRoleCustomAssignmentsResource = new AdminRoleCustomAssignments("adminRoleCustomAssignmentsResource", AdminRoleCustomAssignmentsArgs.builder()        
        .customRoleId("string")
        .resourceSetId("string")
        .members("string")
        .build());
    
    admin_role_custom_assignments_resource = okta.AdminRoleCustomAssignments("adminRoleCustomAssignmentsResource",
        custom_role_id="string",
        resource_set_id="string",
        members=["string"])
    
    const adminRoleCustomAssignmentsResource = new okta.AdminRoleCustomAssignments("adminRoleCustomAssignmentsResource", {
        customRoleId: "string",
        resourceSetId: "string",
        members: ["string"],
    });
    
    type: okta:AdminRoleCustomAssignments
    properties:
        customRoleId: string
        members:
            - string
        resourceSetId: string
    

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

    CustomRoleId string
    ID of the Custom Role.
    ResourceSetId string
    ID of the target Resource Set.
    Members List<string>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    CustomRoleId string
    ID of the Custom Role.
    ResourceSetId string
    ID of the target Resource Set.
    Members []string
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    customRoleId String
    ID of the Custom Role.
    resourceSetId String
    ID of the target Resource Set.
    members List<String>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    customRoleId string
    ID of the Custom Role.
    resourceSetId string
    ID of the target Resource Set.
    members string[]
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    custom_role_id str
    ID of the Custom Role.
    resource_set_id str
    ID of the target Resource Set.
    members Sequence[str]
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    customRoleId String
    ID of the Custom Role.
    resourceSetId String
    ID of the target Resource Set.
    members List<String>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AdminRoleCustomAssignments 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 AdminRoleCustomAssignments Resource

    Get an existing AdminRoleCustomAssignments 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?: AdminRoleCustomAssignmentsState, opts?: CustomResourceOptions): AdminRoleCustomAssignments
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            custom_role_id: Optional[str] = None,
            members: Optional[Sequence[str]] = None,
            resource_set_id: Optional[str] = None) -> AdminRoleCustomAssignments
    func GetAdminRoleCustomAssignments(ctx *Context, name string, id IDInput, state *AdminRoleCustomAssignmentsState, opts ...ResourceOption) (*AdminRoleCustomAssignments, error)
    public static AdminRoleCustomAssignments Get(string name, Input<string> id, AdminRoleCustomAssignmentsState? state, CustomResourceOptions? opts = null)
    public static AdminRoleCustomAssignments get(String name, Output<String> id, AdminRoleCustomAssignmentsState 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:
    CustomRoleId string
    ID of the Custom Role.
    Members List<string>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    ResourceSetId string
    ID of the target Resource Set.
    CustomRoleId string
    ID of the Custom Role.
    Members []string
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    ResourceSetId string
    ID of the target Resource Set.
    customRoleId String
    ID of the Custom Role.
    members List<String>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    resourceSetId String
    ID of the target Resource Set.
    customRoleId string
    ID of the Custom Role.
    members string[]
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    resourceSetId string
    ID of the target Resource Set.
    custom_role_id str
    ID of the Custom Role.
    members Sequence[str]
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    resource_set_id str
    ID of the target Resource Set.
    customRoleId String
    ID of the Custom Role.
    members List<String>
    The hrefs that point to User(s) and/or Group(s) that receive the Role. At least one permission must be specified when creating custom role.
    resourceSetId String
    ID of the target Resource Set.

    Import

    Okta Custom Admin Role Assignments can be imported via the Okta ID.

     $ pulumi import okta:index/adminRoleCustomAssignments:AdminRoleCustomAssignments example &#60;resource_set_id&#62;/&#60;custom_role_id&#62;
    

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

    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.8.0 published on Saturday, Mar 2, 2024 by Pulumi