Package com.okta.sdk.resource.group
Interface Group
-
- All Superinterfaces:
Deletable
,ExtensibleResource
,java.util.Map<java.lang.String,java.lang.Object>
,PropertyRetriever
,Resource
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00") public interface Group extends ExtensibleResource, Deletable
Group
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Role
assignRole(AssignRoleRequest assignRoleRequest)
Assigns a Role to a GroupRole
assignRole(AssignRoleRequest assignRoleRequest, java.lang.Boolean disableNotifications)
Assigns a Role to a Groupvoid
delete()
Remove Group Removes a group with `OKTA_GROUP` type from your organization.java.util.Date
getCreated()
java.util.Map<java.lang.String,java.lang.Object>
getEmbedded()
java.lang.String
getId()
java.util.Date
getLastMembershipUpdated()
java.util.Date
getLastUpdated()
java.util.Map<java.lang.String,java.lang.Object>
getLinks()
java.util.List<java.lang.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(java.lang.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 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
-
Methods inherited from interface com.okta.sdk.resource.PropertyRetriever
getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList
-
Methods inherited from interface com.okta.sdk.resource.Resource
getResourceHref, setResourceHref
-
-
-
-
Method Detail
-
getEmbedded
java.util.Map<java.lang.String,java.lang.Object> getEmbedded()
-
getLinks
java.util.Map<java.lang.String,java.lang.Object> getLinks()
-
getCreated
java.util.Date getCreated()
-
getId
java.lang.String getId()
-
getLastMembershipUpdated
java.util.Date getLastMembershipUpdated()
-
getLastUpdated
java.util.Date getLastUpdated()
-
getObjectClass
java.util.List<java.lang.String> getObjectClass()
-
getProfile
GroupProfile getProfile()
-
setProfile
Group setProfile(GroupProfile profile)
-
getType
GroupType getType()
-
assignRole
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/groups/{groupId}/roles") Role assignRole(AssignRoleRequest assignRoleRequest, java.lang.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-02-14T12:54:39.514-06:00", 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-02-14T12:54:39.514-06:00", 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-02-14T12:54:39.514-06:00", 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-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/groups/{groupId}/users/{userId}") void removeUser(java.lang.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-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/apps") ApplicationList listApplications()
List Assigned Applications Enumerates all applications that are assigned to a group.- Returns:
- ApplicationList
-
-