com.okta.sdk.resource.user

Interface Role

All Superinterfaces:

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

All Known Implementing Classes:

DefaultRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface Role
extends ExtensibleResource

Role

Nested Class Summary

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

Map.Entry<K,V>

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()
RoleStatus	getStatus()
RoleType	getType()
Role	setAssignmentType(RoleAssignmentType assignmentType)
Role	setDescription(String description)
Role	setType(RoleType type)

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

getAssignmentType

RoleAssignmentType getAssignmentType()

setAssignmentType

Role setAssignmentType(RoleAssignmentType assignmentType)

getCreated

Date getCreated()

getDescription

String getDescription()

setDescription

Role setDescription(String description)

getId

String getId()

getLabel

String getLabel()

getLastUpdated

Date getLastUpdated()

getStatus

RoleStatus getStatus()

getType

RoleType getType()

setType

Role setType(RoleType type)

addAdminGroupTarget

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

Parameters:

targetGroupId - (required)

addAppTargetToAdminRoleForUser

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

Success

Parameters:

appName - (required)

addAppInstanceTargetToAdminRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
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

Parameters:

appName - (required)

applicationId - (required)

addAppTargetToAppAdminRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
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

Parameters:

appName - (required)

applicationId - (required)

addAllAppsAsTargetToRole

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

Success

addAppTargetToAdminRole

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

Success

Parameters:

appName - (required)