com.okta.sdk.impl.resource.user

Class DefaultRole

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

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

com.okta.sdk.impl.resource.user.DefaultRole

All Implemented Interfaces:

ExtensibleResource, PropertyRetriever, Resource, Saveable<Role>, Role, Map<String,Object>

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

Role

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
DefaultRole(InternalDataStore dataStore)
DefaultRole(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	addAdminGroupTarget(String targetGroupId)
void	addAllAppsAsTargetToRole() Success
void	addAppInstanceTargetToAdminRole(String appName, String applicationId) Add App Instance Target to App Administrator Role given to a Group Add App Instance Target to App Administrator Role given to a Group
void	addAppTargetToAdminRole(String appName) Success
void	addAppTargetToAdminRoleForUser(String appName) Success
void	addAppTargetToAppAdminRoleForUser(String appName, String applicationId) Add App Instance Target to App Administrator Role given to a User Add App Instance Target to App Administrator Role given to a User
RoleAssignmentType	getAssignmentType()
Date	getCreated()
String	getDescription()
Map<String,Object>	getEmbedded()
String	getId()
String	getLabel()
Date	getLastUpdated()
Map<String,Object>	getLinks()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
RoleStatus	getStatus()
RoleType	getType()
Role	setAssignmentType(RoleAssignmentType assignmentType)
Role	setDescription(String description)
Role	setType(RoleType type)

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

delete, 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, equals, finalize, getClass, hashCode, 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

DefaultRole

public DefaultRole(InternalDataStore dataStore)

DefaultRole

public DefaultRole(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<Role>

Returns:

The type of resource this class represents.

getEmbedded

public Map<String,Object> getEmbedded()

Specified by:

getEmbedded in interface Role

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface Role

getAssignmentType

public RoleAssignmentType getAssignmentType()

Specified by:

getAssignmentType in interface Role

setAssignmentType

public Role setAssignmentType(RoleAssignmentType assignmentType)

Specified by:

setAssignmentType in interface Role

getCreated

public Date getCreated()

Specified by:

getCreated in interface Role

getDescription

public String getDescription()

Specified by:

getDescription in interface Role

setDescription

public Role setDescription(String description)

Specified by:

setDescription in interface Role

getId

public String getId()

Specified by:

getId in interface Role

getLabel

public String getLabel()

Specified by:

getLabel in interface Role

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface Role

getStatus

public RoleStatus getStatus()

Specified by:

getStatus in interface Role

getType

public RoleType getType()

Specified by:

getType in interface Role

setType

public Role setType(RoleType type)

Specified by:

setType in interface Role

addAdminGroupTarget

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}")
public void addAdminGroupTarget(String targetGroupId)

Specified by:

addAdminGroupTarget in interface Role

Parameters:

targetGroupId - (required)

addAppTargetToAdminRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}")
public void addAppTargetToAdminRoleForUser(String appName)

Success

Specified by:

addAppTargetToAdminRoleForUser in interface Role

Parameters:

appName - (required)

addAppInstanceTargetToAdminRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
public void addAppInstanceTargetToAdminRole(String appName,
                                                                                                                                                                                                                                                                                        String applicationId)

Add App Instance Target to App Administrator Role given to a Group Add App Instance Target to App Administrator Role given to a Group

Specified by:

addAppInstanceTargetToAdminRole in interface Role

Parameters:

appName - (required)

applicationId - (required)

addAppTargetToAppAdminRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
public void addAppTargetToAppAdminRoleForUser(String appName,
                                                                                                                                                                                                                                                                                        String applicationId)

Add App Instance Target to App Administrator Role given to a User Add App Instance Target to App Administrator Role given to a User

Specified by:

addAppTargetToAppAdminRoleForUser in interface Role

Parameters:

appName - (required)

applicationId - (required)

addAllAppsAsTargetToRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
public void addAllAppsAsTargetToRole()

Success

Specified by:

addAllAppsAsTargetToRole in interface Role

addAppTargetToAdminRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}")
public void addAppTargetToAdminRole(String appName)

Success

Specified by:

addAppTargetToAdminRole in interface Role

Parameters:

appName - (required)