1. Docs
  2. Reference
  3. API
  4. Okta
  5. group
  6. Roles

Roles

Creates Group level Admin Role Assignments.

This resource allows you to create and configure Group level Admin Role Assignments.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Group.Roles("example", new Okta.Group.RolesArgs
        {
            AdminRoles = 
            {
                "SUPER_ADMIN",
            },
            GroupId = "<group id>",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.group.Roles("example",
    admin_roles=["SUPER_ADMIN"],
    group_id="<group id>")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.group.Roles("example", {
    adminRoles: ["SUPER_ADMIN"],
    groupId: "<group id>",
});

Create a Roles Resource

new Roles(name: string, args: RolesArgs, opts?: CustomResourceOptions);
def Roles(resource_name, opts=None, admin_roles=None, group_id=None, __props__=None);
func NewRoles(ctx *Context, name string, args RolesArgs, opts ...ResourceOption) (*Roles, error)
public Roles(string name, RolesArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RolesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RolesArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RolesArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Roles Resource Properties

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

Inputs

The Roles resource accepts the following input properties:

GroupId string

The ID of group to attach admin roles to.

AdminRoles List<string>

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

GroupId string

The ID of group to attach admin roles to.

AdminRoles []string

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

groupId string

The ID of group to attach admin roles to.

adminRoles string[]

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

group_id str

The ID of group to attach admin roles to.

admin_roles List[str]

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

Outputs

All input properties are implicitly available as output properties. Additionally, the Roles 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Roles Resource

Get an existing Roles 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?: RolesState, opts?: CustomResourceOptions): Roles
static get(resource_name, id, opts=None, admin_roles=None, group_id=None, __props__=None);
func GetRoles(ctx *Context, name string, id IDInput, state *RolesState, opts ...ResourceOption) (*Roles, error)
public static Roles Get(string name, Input<string> id, RolesState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AdminRoles List<string>

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

GroupId string

The ID of group to attach admin roles to.

AdminRoles []string

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

GroupId string

The ID of group to attach admin roles to.

adminRoles string[]

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

groupId string

The ID of group to attach admin roles to.

admin_roles List[str]

Admin roles associated with the group. It can be any of the following values "SUPER_ADMIN", "ORG_ADMIN", "APP_ADMIN", "USER_ADMIN", "HELP_DESK_ADMIN", "READ_ONLY_ADMIN", "MOBILE_ADMIN", "API_ACCESS_MANAGEMENT_ADMIN", "REPORT_ADMIN".

group_id str

The ID of group to attach admin roles to.

Package Details

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