Package com.okta.sdk.resource.api

Class RoleAssignmentApi

java.lang.Object

com.okta.sdk.resource.api.RoleAssignmentApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
           comments="Generator version: 7.7.0")
public class RoleAssignmentApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RoleAssignmentApi()
RoleAssignmentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Client	assignRoleToClient(String clientId, AssignRoleToClientRequest assignRoleToClientRequest)	Assign Role to Client Assigns a Role to a Client
Client	assignRoleToClient(String clientId, AssignRoleToClientRequest assignRoleToClientRequest, Map<String,String> additionalHeaders)	Assign Role to Client Assigns a Role to a Client
Role	assignRoleToGroup(String groupId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications)	Assign a Role to a Group Assigns a role to a group
Role	assignRoleToGroup(String groupId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications, Map<String,String> additionalHeaders)	Assign a Role to a Group Assigns a role to a group
Role	assignRoleToUser(String userId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications)	Assign a Role to a User Assigns a role to a user identified by `userId`
Role	assignRoleToUser(String userId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications, Map<String,String> additionalHeaders)	Assign a Role to a User Assigns a role to a user identified by `userId`
void	deleteRoleFromClient(String clientId, String roleId)	Unassign a Role from a Client Unassigns a Role from a Client
void	deleteRoleFromClient(String clientId, String roleId, Map<String,String> additionalHeaders)	Unassign a Role from a Client Unassigns a Role from a Client
ApiClient	getApiClient()
Role	getGroupAssignedRole(String groupId, String roleId)	Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`
Role	getGroupAssignedRole(String groupId, String roleId, Map<String,String> additionalHeaders)	Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Role	getUserAssignedRole(String userId, String roleId)	Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`
Role	getUserAssignedRole(String userId, String roleId, Map<String,String> additionalHeaders)	Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`
List<Role>	listAssignedRolesForUser(String userId, String expand)	List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`
List<Role>	listAssignedRolesForUser(String userId, String expand, Map<String,String> additionalHeaders)	List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`
List<Role>	listGroupAssignedRoles(String groupId, String expand)	List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`
List<Role>	listGroupAssignedRoles(String groupId, String expand, Map<String,String> additionalHeaders)	List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`
Client	listRolesForClient(String clientId)	List all Roles for a Client Lists all Roles by `clientId`
Client	listRolesForClient(String clientId, Map<String,String> additionalHeaders)	List all Roles for a Client Lists all Roles by `clientId`
RoleAssignedUsers	listUsersWithRoleAssignments(String after, Integer limit)	List all Users with Role Assignments Lists all users with Role Assignments
RoleAssignedUsers	listUsersWithRoleAssignments(String after, Integer limit, Map<String,String> additionalHeaders)	List all Users with Role Assignments Lists all users with Role Assignments
Client	retrieveClientRole(String clientId, String roleId)	Retrieve a Client Role Retrieves a Client Role
Client	retrieveClientRole(String clientId, String roleId, Map<String,String> additionalHeaders)	Retrieve a Client Role Retrieves a Client Role
void	setApiClient(ApiClient apiClient)
void	unassignRoleFromGroup(String groupId, String roleId)	Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`
void	unassignRoleFromGroup(String groupId, String roleId, Map<String,String> additionalHeaders)	Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`
void	unassignRoleFromUser(String userId, String roleId)	Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`
void	unassignRoleFromUser(String userId, String roleId, Map<String,String> additionalHeaders)	Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RoleAssignmentApi

public RoleAssignmentApi()

RoleAssignmentApi

public RoleAssignmentApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignRoleToClient

public Client assignRoleToClient(String clientId,
 AssignRoleToClientRequest assignRoleToClientRequest)
                          throws ApiException

Assign Role to Client Assigns a Role to a Client

Parameters:

clientId - `client_id` of the app (required)

assignRoleToClientRequest - (required)

Returns:

Client

Throws:

ApiException - if fails to make API call

assignRoleToClient

public Client assignRoleToClient(String clientId,
 AssignRoleToClientRequest assignRoleToClientRequest,
 Map<String,String> additionalHeaders)
                          throws ApiException

Assign Role to Client Assigns a Role to a Client

Parameters:

clientId - `client_id` of the app (required)

assignRoleToClientRequest - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Client

Throws:

ApiException - if fails to make API call

assignRoleToGroup

public Role assignRoleToGroup(String groupId,
 AssignRoleRequest assignRoleRequest,
 Boolean disableNotifications)
                       throws ApiException

Assign a Role to a Group Assigns a role to a group

Parameters:

groupId - The `id` of the group (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the group third-party admin status (optional)

Returns:

Role

Throws:

ApiException - if fails to make API call

assignRoleToGroup

public Role assignRoleToGroup(String groupId,
 AssignRoleRequest assignRoleRequest,
 Boolean disableNotifications,
 Map<String,String> additionalHeaders)
                       throws ApiException

Assign a Role to a Group Assigns a role to a group

Parameters:

groupId - The `id` of the group (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the group third-party admin status (optional)

additionalHeaders - additionalHeaders for this call

Returns:

Role

Throws:

ApiException - if fails to make API call

assignRoleToUser

public Role assignRoleToUser(String userId,
 AssignRoleRequest assignRoleRequest,
 Boolean disableNotifications)
                      throws ApiException

Assign a Role to a User Assigns a role to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the user third-party admin status (optional)

Returns:

Role

Throws:

ApiException - if fails to make API call

assignRoleToUser

public Role assignRoleToUser(String userId,
 AssignRoleRequest assignRoleRequest,
 Boolean disableNotifications,
 Map<String,String> additionalHeaders)
                      throws ApiException

Assign a Role to a User Assigns a role to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the user third-party admin status (optional)

additionalHeaders - additionalHeaders for this call

Returns:

Role

Throws:

ApiException - if fails to make API call

deleteRoleFromClient

public void deleteRoleFromClient(String clientId,
 String roleId)
                          throws ApiException

Unassign a Role from a Client Unassigns a Role from a Client

Parameters:

clientId - `client_id` of the app (required)

roleId - `id` of the Role (required)

Throws:

ApiException - if fails to make API call

deleteRoleFromClient

public void deleteRoleFromClient(String clientId,
 String roleId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Unassign a Role from a Client Unassigns a Role from a Client

Parameters:

clientId - `client_id` of the app (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getGroupAssignedRole

public Role getGroupAssignedRole(String groupId,
 String roleId)
                          throws ApiException

Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

roleId - `id` of the Role (required)

Returns:

Role

Throws:

ApiException - if fails to make API call

getGroupAssignedRole

public Role getGroupAssignedRole(String groupId,
 String roleId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Returns:

Role

Throws:

ApiException - if fails to make API call

getUserAssignedRole

public Role getUserAssignedRole(String userId,
 String roleId)
                         throws ApiException

Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

roleId - `id` of the Role (required)

Returns:

Role

Throws:

ApiException - if fails to make API call

getUserAssignedRole

public Role getUserAssignedRole(String userId,
 String roleId,
 Map<String,String> additionalHeaders)
                         throws ApiException

Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Returns:

Role

Throws:

ApiException - if fails to make API call

listAssignedRolesForUser

public List<Role> listAssignedRolesForUser(String userId,
 String expand)
                                    throws ApiException

List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

expand - (optional)

Returns:

List<Role>

Throws:

ApiException - if fails to make API call

listAssignedRolesForUser

public List<Role> listAssignedRolesForUser(String userId,
 String expand,
 Map<String,String> additionalHeaders)
                                    throws ApiException

List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

expand - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<Role>

Throws:

ApiException - if fails to make API call

listGroupAssignedRoles

public List<Role> listGroupAssignedRoles(String groupId,
 String expand)
                                  throws ApiException

List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

expand - (optional)

Returns:

List<Role>

Throws:

ApiException - if fails to make API call

listGroupAssignedRoles

public List<Role> listGroupAssignedRoles(String groupId,
 String expand,
 Map<String,String> additionalHeaders)
                                  throws ApiException

List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

expand - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<Role>

Throws:

ApiException - if fails to make API call

listRolesForClient

public Client listRolesForClient(String clientId)
                          throws ApiException

List all Roles for a Client Lists all Roles by `clientId`

Parameters:

clientId - `client_id` of the app (required)

Returns:

Client

Throws:

ApiException - if fails to make API call

listRolesForClient

public Client listRolesForClient(String clientId,
 Map<String,String> additionalHeaders)
                          throws ApiException

List all Roles for a Client Lists all Roles by `clientId`

Parameters:

clientId - `client_id` of the app (required)

additionalHeaders - additionalHeaders for this call

Returns:

Client

Throws:

ApiException - if fails to make API call

listUsersWithRoleAssignments

public RoleAssignedUsers listUsersWithRoleAssignments(String after,
 Integer limit)
                                               throws ApiException

List all Users with Role Assignments Lists all users with Role Assignments

Parameters:

after - (optional)

limit - Specifies the number of results returned. Defaults to `100`. (optional, default to 100)

Returns:

RoleAssignedUsers

Throws:

ApiException - if fails to make API call

listUsersWithRoleAssignments

public RoleAssignedUsers listUsersWithRoleAssignments(String after,
 Integer limit,
 Map<String,String> additionalHeaders)
                                               throws ApiException

List all Users with Role Assignments Lists all users with Role Assignments

Parameters:

after - (optional)

limit - Specifies the number of results returned. Defaults to `100`. (optional, default to 100)

additionalHeaders - additionalHeaders for this call

Returns:

RoleAssignedUsers

Throws:

ApiException - if fails to make API call

retrieveClientRole

public Client retrieveClientRole(String clientId,
 String roleId)
                          throws ApiException

Retrieve a Client Role Retrieves a Client Role

Parameters:

clientId - `client_id` of the app (required)

roleId - `id` of the Role (required)

Returns:

Client

Throws:

ApiException - if fails to make API call

retrieveClientRole

public Client retrieveClientRole(String clientId,
 String roleId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Retrieve a Client Role Retrieves a Client Role

Parameters:

clientId - `client_id` of the app (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Returns:

Client

Throws:

ApiException - if fails to make API call

unassignRoleFromGroup

public void unassignRoleFromGroup(String groupId,
 String roleId)
                           throws ApiException

Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

roleId - `id` of the Role (required)

Throws:

ApiException - if fails to make API call

unassignRoleFromGroup

public void unassignRoleFromGroup(String groupId,
 String roleId,
 Map<String,String> additionalHeaders)
                           throws ApiException

Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`

Parameters:

groupId - The `id` of the group (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

unassignRoleFromUser

public void unassignRoleFromUser(String userId,
 String roleId)
                          throws ApiException

Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

roleId - `id` of the Role (required)

Throws:

ApiException - if fails to make API call

unassignRoleFromUser

public void unassignRoleFromUser(String userId,
 String roleId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`

Parameters:

userId - ID of an existing Okta user (required)

roleId - `id` of the Role (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()