com.pulumi.okta.group.RoleArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of okta Show documentation
Show all versions of okta Show documentation
A Pulumi package for creating and managing okta resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.okta.group;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class RoleArgs extends com.pulumi.resources.ResourceArgs {
public static final RoleArgs Empty = new RoleArgs();
/**
* When this setting is enabled, the admins won't receive any of the default Okta administrator emails. These admins also
* won't have access to contact Okta Support and open support cases on behalf of your org.
*
*/
@Import(name="disableNotifications")
private @Nullable Output disableNotifications;
/**
* @return When this setting is enabled, the admins won't receive any of the default Okta administrator emails. These admins also
* won't have access to contact Okta Support and open support cases on behalf of your org.
*
*/
public Optional> disableNotifications() {
return Optional.ofNullable(this.disableNotifications);
}
/**
* ID of group to attach admin roles to
*
*/
@Import(name="groupId", required=true)
private Output groupId;
/**
* @return ID of group to attach admin roles to
*
*/
public Output groupId() {
return this.groupId;
}
/**
* Resource Set ID. Required for role_type = `CUSTOM`
*
*/
@Import(name="resourceSetId")
private @Nullable Output resourceSetId;
/**
* @return Resource Set ID. Required for role_type = `CUSTOM`
*
*/
public Optional> resourceSetId() {
return Optional.ofNullable(this.resourceSetId);
}
/**
* Role ID. Required for role_type = `CUSTOM`
*
*/
@Import(name="roleId")
private @Nullable Output roleId;
/**
* @return Role ID. Required for role_type = `CUSTOM`
*
*/
public Optional> roleId() {
return Optional.ofNullable(this.roleId);
}
/**
* Admin role assigned to the group. It can be any one of the following values: "API_ADMIN", "APP_ADMIN", "CUSTOM",
* "GROUP_MEMBERSHIP_ADMIN", "HELP_DESK_ADMIN", "MOBILE_ADMIN", "ORG_ADMIN", "READ_ONLY_ADMIN", "REPORT_ADMIN",
* "SUPER_ADMIN", "USER_ADMIN" . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types). -
* "USER_ADMIN" is the Group Administrator.
*
*/
@Import(name="roleType", required=true)
private Output roleType;
/**
* @return Admin role assigned to the group. It can be any one of the following values: "API_ADMIN", "APP_ADMIN", "CUSTOM",
* "GROUP_MEMBERSHIP_ADMIN", "HELP_DESK_ADMIN", "MOBILE_ADMIN", "ORG_ADMIN", "READ_ONLY_ADMIN", "REPORT_ADMIN",
* "SUPER_ADMIN", "USER_ADMIN" . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types). -
* "USER_ADMIN" is the Group Administrator.
*
*/
public Output roleType() {
return this.roleType;
}
/**
* A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app
* name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only
* supported when used with the role type `APP_ADMIN`.
*
*/
@Import(name="targetAppLists")
private @Nullable Output> targetAppLists;
/**
* @return A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app
* name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only
* supported when used with the role type `APP_ADMIN`.
*
*/
public Optional>> targetAppLists() {
return Optional.ofNullable(this.targetAppLists);
}
/**
* A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types:
* `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
*
*/
@Import(name="targetGroupLists")
private @Nullable Output> targetGroupLists;
/**
* @return A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types:
* `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
*
*/
public Optional>> targetGroupLists() {
return Optional.ofNullable(this.targetGroupLists);
}
private RoleArgs() {}
private RoleArgs(RoleArgs $) {
this.disableNotifications = $.disableNotifications;
this.groupId = $.groupId;
this.resourceSetId = $.resourceSetId;
this.roleId = $.roleId;
this.roleType = $.roleType;
this.targetAppLists = $.targetAppLists;
this.targetGroupLists = $.targetGroupLists;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(RoleArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private RoleArgs $;
public Builder() {
$ = new RoleArgs();
}
public Builder(RoleArgs defaults) {
$ = new RoleArgs(Objects.requireNonNull(defaults));
}
/**
* @param disableNotifications When this setting is enabled, the admins won't receive any of the default Okta administrator emails. These admins also
* won't have access to contact Okta Support and open support cases on behalf of your org.
*
* @return builder
*
*/
public Builder disableNotifications(@Nullable Output disableNotifications) {
$.disableNotifications = disableNotifications;
return this;
}
/**
* @param disableNotifications When this setting is enabled, the admins won't receive any of the default Okta administrator emails. These admins also
* won't have access to contact Okta Support and open support cases on behalf of your org.
*
* @return builder
*
*/
public Builder disableNotifications(Boolean disableNotifications) {
return disableNotifications(Output.of(disableNotifications));
}
/**
* @param groupId ID of group to attach admin roles to
*
* @return builder
*
*/
public Builder groupId(Output groupId) {
$.groupId = groupId;
return this;
}
/**
* @param groupId ID of group to attach admin roles to
*
* @return builder
*
*/
public Builder groupId(String groupId) {
return groupId(Output.of(groupId));
}
/**
* @param resourceSetId Resource Set ID. Required for role_type = `CUSTOM`
*
* @return builder
*
*/
public Builder resourceSetId(@Nullable Output resourceSetId) {
$.resourceSetId = resourceSetId;
return this;
}
/**
* @param resourceSetId Resource Set ID. Required for role_type = `CUSTOM`
*
* @return builder
*
*/
public Builder resourceSetId(String resourceSetId) {
return resourceSetId(Output.of(resourceSetId));
}
/**
* @param roleId Role ID. Required for role_type = `CUSTOM`
*
* @return builder
*
*/
public Builder roleId(@Nullable Output roleId) {
$.roleId = roleId;
return this;
}
/**
* @param roleId Role ID. Required for role_type = `CUSTOM`
*
* @return builder
*
*/
public Builder roleId(String roleId) {
return roleId(Output.of(roleId));
}
/**
* @param roleType Admin role assigned to the group. It can be any one of the following values: "API_ADMIN", "APP_ADMIN", "CUSTOM",
* "GROUP_MEMBERSHIP_ADMIN", "HELP_DESK_ADMIN", "MOBILE_ADMIN", "ORG_ADMIN", "READ_ONLY_ADMIN", "REPORT_ADMIN",
* "SUPER_ADMIN", "USER_ADMIN" . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types). -
* "USER_ADMIN" is the Group Administrator.
*
* @return builder
*
*/
public Builder roleType(Output roleType) {
$.roleType = roleType;
return this;
}
/**
* @param roleType Admin role assigned to the group. It can be any one of the following values: "API_ADMIN", "APP_ADMIN", "CUSTOM",
* "GROUP_MEMBERSHIP_ADMIN", "HELP_DESK_ADMIN", "MOBILE_ADMIN", "ORG_ADMIN", "READ_ONLY_ADMIN", "REPORT_ADMIN",
* "SUPER_ADMIN", "USER_ADMIN" . See [API Docs](https://developer.okta.com/docs/reference/api/roles/#role-types). -
* "USER_ADMIN" is the Group Administrator.
*
* @return builder
*
*/
public Builder roleType(String roleType) {
return roleType(Output.of(roleType));
}
/**
* @param targetAppLists A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app
* name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only
* supported when used with the role type `APP_ADMIN`.
*
* @return builder
*
*/
public Builder targetAppLists(@Nullable Output> targetAppLists) {
$.targetAppLists = targetAppLists;
return this;
}
/**
* @param targetAppLists A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app
* name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only
* supported when used with the role type `APP_ADMIN`.
*
* @return builder
*
*/
public Builder targetAppLists(List targetAppLists) {
return targetAppLists(Output.of(targetAppLists));
}
/**
* @param targetAppLists A list of app names (name represents set of app instances, like 'salesforce' or 'facebook'), or a combination of app
* name and app instance ID (like 'facebook.0oapsqQ6dv19pqyEo0g3') you would like as the targets of the admin role. - Only
* supported when used with the role type `APP_ADMIN`.
*
* @return builder
*
*/
public Builder targetAppLists(String... targetAppLists) {
return targetAppLists(List.of(targetAppLists));
}
/**
* @param targetGroupLists A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types:
* `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
*
* @return builder
*
*/
public Builder targetGroupLists(@Nullable Output> targetGroupLists) {
$.targetGroupLists = targetGroupLists;
return this;
}
/**
* @param targetGroupLists A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types:
* `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
*
* @return builder
*
*/
public Builder targetGroupLists(List targetGroupLists) {
return targetGroupLists(Output.of(targetGroupLists));
}
/**
* @param targetGroupLists A list of group IDs you would like as the targets of the admin role. - Only supported when used with the role types:
* `GROUP_MEMBERSHIP_ADMIN`, `HELP_DESK_ADMIN`, or `USER_ADMIN`.
*
* @return builder
*
*/
public Builder targetGroupLists(String... targetGroupLists) {
return targetGroupLists(List.of(targetGroupLists));
}
public RoleArgs build() {
if ($.groupId == null) {
throw new MissingRequiredPropertyException("RoleArgs", "groupId");
}
if ($.roleType == null) {
throw new MissingRequiredPropertyException("RoleArgs", "roleType");
}
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy