com.okta.sdk.resource.group.rule

Interface GroupRule

All Superinterfaces:

Deletable, ExtensibleResource, java.util.Map<java.lang.String,java.lang.Object>, PropertyRetriever, Resource

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00")
public interface GroupRule
extends ExtensibleResource, Deletable

GroupRule

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	activate() Activate a group Rule Activates a specific group rule by id from your organization
void	deactivate() Deactivate a group Rule Deactivates a specific group rule by id from your organization
void	delete() Delete a group Rule Removes a specific group rule by id from your organization
void	delete(java.lang.Boolean removeUsers) Delete a group Rule Removes a specific group rule by id from your organization
GroupRuleAction	getActions()
GroupRuleConditions	getConditions()
java.util.Date	getCreated()
java.lang.String	getId()
java.util.Date	getLastUpdated()
java.lang.String	getName()
GroupRuleStatus	getStatus()
java.lang.String	getType()
GroupRule	setActions(GroupRuleAction actions)
GroupRule	setConditions(GroupRuleConditions conditions)
GroupRule	setName(java.lang.String name)
GroupRule	setType(java.lang.String type)
GroupRule	update() Updates a group rule.

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getActions

GroupRuleAction getActions()

setActions

GroupRule setActions(GroupRuleAction actions)

getConditions

GroupRuleConditions getConditions()

setConditions

GroupRule setConditions(GroupRuleConditions conditions)

getCreated

java.util.Date getCreated()

getId

java.lang.String getId()

getLastUpdated

java.util.Date getLastUpdated()

getName

java.lang.String getName()

setName

GroupRule setName(java.lang.String name)

getStatus

GroupRuleStatus getStatus()

getType

java.lang.String getType()

setType

GroupRule setType(java.lang.String type)

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/deactivate")
void deactivate()

Deactivate a group Rule Deactivates a specific group rule by id from your organization

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00",
           comments="PUT - /api/v1/groups/rules/{ruleId}")
GroupRule update()

Updates a group rule. Only `INACTIVE` rules can be updated.

Returns:

GroupRule

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
void delete(java.lang.Boolean removeUsers)

Delete a group Rule Removes a specific group rule by id from your organization

Parameters:

removeUsers - Indicates whether to keep or remove users from groups assigned by this rule. (optional)

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
void delete()

Delete a group Rule Removes a specific group rule by id from your organization

Specified by:

delete in interface Deletable

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-04-29T13:24:36.001-05:00",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/activate")
void activate()

Activate a group Rule Activates a specific group rule by id from your organization