com.okta.sdk.resource.group

Interface Group

All Superinterfaces:

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

All Known Implementing Classes:

DefaultGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z")
public interface Group
extends ExtensibleResource, Deletable

Group

Nested Class Summary

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

Map.Entry<K,V>

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()
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 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

getEmbedded

Map<String,Object> getEmbedded()

getLinks

Map<String,Object> getLinks()

getCreated

Date getCreated()

getId

String getId()

getLastMembershipUpdated

Date getLastMembershipUpdated()

getLastUpdated

Date getLastUpdated()

getObjectClass

List<String> getObjectClass()

getProfile

GroupProfile getProfile()

setProfile

Group setProfile(GroupProfile profile)

getType

GroupType getType()

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="POST - /api/v1/groups/{groupId}/roles")
Role assignRole(AssignRoleRequest assignRoleRequest,
                                                                                                                                                                                               Boolean disableNotifications)

Assigns a Role to a Group

Parameters:

assignRoleRequest - (required)

disableNotifications - (optional)

Returns:

Role

assignRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="POST - /api/v1/groups/{groupId}/roles")
Role assignRole(AssignRoleRequest assignRoleRequest)

Assigns a Role to a Group

Parameters:

assignRoleRequest - (required)

Returns:

Role

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="GET - /api/v1/groups/{groupId}/users")
UserList listUsers()

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

Returns:

UserList

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="PUT - /api/v1/groups/{groupId}")
Group update()

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

Returns:

Group

removeUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="DELETE - /api/v1/groups/{groupId}/users/{userId}")
void removeUser(String userId)

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

Parameters:

userId - (required)

listApplications

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="GET - /api/v1/groups/{groupId}/apps")
ApplicationList listApplications()

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

Returns:

ApplicationList

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-09-29T14:57:29.703Z",
           comments="DELETE - /api/v1/groups/{groupId}")
void delete()

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

Specified by:

delete in interface Deletable