com.okta.sdk.impl.resource.group

Class DefaultGroup

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<Group>

com.okta.sdk.impl.resource.group.DefaultGroup

All Implemented Interfaces:

Deletable, ExtensibleResource, Group, PropertyRetriever, Resource, Saveable<Group>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultGroup
extends AbstractInstanceResource<Group>
implements Group

Group

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultGroup(InternalDataStore dataStore)
DefaultGroup(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
Role	assignRole(AssignRoleRequest assignRoleRequest) Assigns a Role to a Group
Role	assignRole(AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assigns a Role to a Group
void	delete() Remove Group Removes a group with `OKTA_GROUP` type from your organization.
Date	getCreated()
Map<String,Object>	getEmbedded()
String	getId()
Date	getLastMembershipUpdated()
Date	getLastUpdated()
Map<String,Object>	getLinks()
List<String>	getObjectClass()
GroupProfile	getProfile()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
GroupType	getType()
ApplicationList	listApplications() List Assigned Applications Enumerates all applications that are assigned to a group.
UserList	listUsers() List Group Members Enumerates all users that are a member of a group.
void	removeUser(String userId) Remove User from Group Removes a user from a group with 'OKTA_GROUP' type.
Group	setProfile(GroupProfile profile)
Group	update() Update Group Updates the profile for a group with `OKTA_GROUP` type from your organization.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DefaultGroup

public DefaultGroup(InternalDataStore dataStore)

DefaultGroup

public DefaultGroup(InternalDataStore dataStore,
                    Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<Group>

Returns:

The type of resource this class represents.

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface Group

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Group

getCreated

public Date getCreated()

Specified by:

getCreated in interface Group

getId

public String getId()

Specified by:

getId in interface Group

getLastMembershipUpdated

public Date getLastMembershipUpdated()

Specified by:

getLastMembershipUpdated in interface Group

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface Group

getObjectClass

public List<String> getObjectClass()

Specified by:

getObjectClass in interface Group

getProfile

public GroupProfile getProfile()

Specified by:

getProfile in interface Group

setProfile

public Group setProfile(GroupProfile profile)

Specified by:

setProfile in interface Group

getType

public GroupType getType()

Specified by:

getType in interface Group

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/groups/{groupId}/roles")
public Role assignRole(AssignRoleRequest assignRoleRequest,
                                                                                                                                                                                                            Boolean disableNotifications)

Assigns a Role to a Group

Specified by:

assignRole in interface Group

Parameters:

assignRoleRequest - (required)

disableNotifications - (optional)

Returns:

Role

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/groups/{groupId}/roles")
public Role assignRole(AssignRoleRequest assignRoleRequest)

Assigns a Role to a Group

Specified by:

assignRole in interface Group

Parameters:

assignRoleRequest - (required)

Returns:

Role

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/groups/{groupId}/users")
public UserList listUsers()

List Group Members Enumerates all users that are a member of a group.

Specified by:

listUsers in interface Group

Returns:

UserList

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/{groupId}")
public Group update()

Update Group Updates the profile for a group with `OKTA_GROUP` type from your organization.

Specified by:

update in interface Group

Returns:

Group

removeUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/groups/{groupId}/users/{userId}")
public void removeUser(String userId)

Remove User from Group Removes a user from a group with 'OKTA_GROUP' type.

Specified by:

removeUser in interface Group

Parameters:

userId - (required)

listApplications

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/groups/{groupId}/apps")
public ApplicationList listApplications()

List Assigned Applications Enumerates all applications that are assigned to a group.

Specified by:

listApplications in interface Group

Returns:

ApplicationList

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/groups/{groupId}")
public void delete()

Remove Group Removes a group with `OKTA_GROUP` type from your organization.

Specified by:

delete in interface Deletable

Specified by:

delete in interface Group

Overrides:

delete in class AbstractInstanceResource<Group>