org.openapitools.client.api

Class ApplicationUsersApi

java.lang.Object

org.openapitools.client.api.ApplicationUsersApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class ApplicationUsersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationUsersApi()
ApplicationUsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
AppUser	assignUserToApplication(String appId, AppUser appUser) Assign a User Assigns a user to an app with credentials and an app-specific [profile](/openapi/okta-management/management/tag/Application/#tag/Application/operation/assignUserToApplication!c=200&path=profile&t=response).
AppUser	assignUserToApplication(String appId, AppUser appUser, Map<String,String> additionalHeaders) Assign a User Assigns a user to an app with credentials and an app-specific [profile](/openapi/okta-management/management/tag/Application/#tag/Application/operation/assignUserToApplication!c=200&path=profile&t=response).
ApiClient	getApiClient()
AppUser	getApplicationUser(String appId, String userId, String expand) Retrieve an assigned User Retrieves a specific user assignment for app by `id`
AppUser	getApplicationUser(String appId, String userId, String expand, Map<String,String> additionalHeaders) Retrieve an assigned User Retrieves a specific user assignment for app by `id`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<AppUser>	listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand) List all assigned Users Lists all assigned users for an app
List<AppUser>	listApplicationUsers(String appId, String q, String queryScope, String after, Integer limit, String filter, String expand, Map<String,String> additionalHeaders) List all assigned Users Lists all assigned users for an app
void	setApiClient(ApiClient apiClient)
void	unassignUserFromApplication(String appId, String userId, Boolean sendEmail) Unassign an App User Unassigns a user from an application
void	unassignUserFromApplication(String appId, String userId, Boolean sendEmail, Map<String,String> additionalHeaders) Unassign an App User Unassigns a user from an application
AppUser	updateApplicationUser(String appId, String userId, AppUser appUser) Update an App Profile for an assigned User Updates a user's profile for an application
AppUser	updateApplicationUser(String appId, String userId, AppUser appUser, Map<String,String> additionalHeaders) Update an App Profile for an assigned User Updates a user's profile for an application

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationUsersApi

public ApplicationUsersApi()

ApplicationUsersApi

public ApplicationUsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignUserToApplication

public AppUser assignUserToApplication(String appId,
                                       AppUser appUser)
                                throws ApiException

Assign a User Assigns a user to an app with credentials and an app-specific [profile](/openapi/okta-management/management/tag/Application/#tag/Application/operation/assignUserToApplication!c=200&path=profile&t=response). Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request. > **Notes:** > * You need to specify the `id` and omit the `credentials` parameter in the request body only for `signOnMode` or authentication schemes (`credentials.scheme`) that don't require credentials. > * You can only specify profile properties that aren't defined by profile mappings when Universal Directory is enabled. > * If your SSO app requires a profile but doesn't have provisioning enabled, you need to add a profile to the request body.

Parameters:

appId - ID of the Application (required)

appUser - (required)

Returns:

AppUser

Throws:

ApiException - if fails to make API call

assignUserToApplication

public AppUser assignUserToApplication(String appId,
                                       AppUser appUser,
                                       Map<String,String> additionalHeaders)
                                throws ApiException

Assign a User Assigns a user to an app with credentials and an app-specific [profile](/openapi/okta-management/management/tag/Application/#tag/Application/operation/assignUserToApplication!c=200&path=profile&t=response). Profile mappings defined for the app are applied first before applying any profile properties that are specified in the request. > **Notes:** > * You need to specify the `id` and omit the `credentials` parameter in the request body only for `signOnMode` or authentication schemes (`credentials.scheme`) that don't require credentials. > * You can only specify profile properties that aren't defined by profile mappings when Universal Directory is enabled. > * If your SSO app requires a profile but doesn't have provisioning enabled, you need to add a profile to the request body.

Parameters:

appId - ID of the Application (required)

appUser - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AppUser

Throws:

ApiException - if fails to make API call

getApplicationUser

public AppUser getApplicationUser(String appId,
                                  String userId,
                                  String expand)
                           throws ApiException

Retrieve an assigned User Retrieves a specific user assignment for app by `id`

Parameters:

appId - ID of the Application (required)

userId - (required)

expand - (optional)

Returns:

AppUser

Throws:

ApiException - if fails to make API call

getApplicationUser

public AppUser getApplicationUser(String appId,
                                  String userId,
                                  String expand,
                                  Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve an assigned User Retrieves a specific user assignment for app by `id`

Parameters:

appId - ID of the Application (required)

userId - (required)

expand - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

AppUser

Throws:

ApiException - if fails to make API call

listApplicationUsers

public List<AppUser> listApplicationUsers(String appId,
                                          String q,
                                          String queryScope,
                                          String after,
                                          Integer limit,
                                          String filter,
                                          String expand)
                                   throws ApiException

List all assigned Users Lists all assigned users for an app

Parameters:

appId - ID of the Application (required)

q - (optional)

queryScope - (optional)

after - specifies the pagination cursor for the next page of assignments (optional)

limit - specifies the number of results for a page (optional, default to -1)

filter - (optional)

expand - (optional)

Returns:

List<AppUser>

Throws:

ApiException - if fails to make API call

listApplicationUsers

public List<AppUser> listApplicationUsers(String appId,
                                          String q,
                                          String queryScope,
                                          String after,
                                          Integer limit,
                                          String filter,
                                          String expand,
                                          Map<String,String> additionalHeaders)
                                   throws ApiException

List all assigned Users Lists all assigned users for an app

Parameters:

appId - ID of the Application (required)

q - (optional)

queryScope - (optional)

after - specifies the pagination cursor for the next page of assignments (optional)

limit - specifies the number of results for a page (optional, default to -1)

filter - (optional)

expand - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<AppUser>

Throws:

ApiException - if fails to make API call

unassignUserFromApplication

public void unassignUserFromApplication(String appId,
                                        String userId,
                                        Boolean sendEmail)
                                 throws ApiException

Unassign an App User Unassigns a user from an application

Parameters:

appId - ID of the Application (required)

userId - (required)

sendEmail - (optional, default to false)

Throws:

ApiException - if fails to make API call

unassignUserFromApplication

public void unassignUserFromApplication(String appId,
                                        String userId,
                                        Boolean sendEmail,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

Unassign an App User Unassigns a user from an application

Parameters:

appId - ID of the Application (required)

userId - (required)

sendEmail - (optional, default to false)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

updateApplicationUser

public AppUser updateApplicationUser(String appId,
                                     String userId,
                                     AppUser appUser)
                              throws ApiException

Update an App Profile for an assigned User Updates a user's profile for an application

Parameters:

appId - ID of the Application (required)

userId - (required)

appUser - (required)

Returns:

AppUser

Throws:

ApiException - if fails to make API call

updateApplicationUser

public AppUser updateApplicationUser(String appId,
                                     String userId,
                                     AppUser appUser,
                                     Map<String,String> additionalHeaders)
                              throws ApiException

Update an App Profile for an assigned User Updates a user's profile for an application

Parameters:

appId - ID of the Application (required)

userId - (required)

appUser - (required)

additionalHeaders - additionalHeaders for this call

Returns:

AppUser

Throws:

ApiException - if fails to make API call

getObjectMapper

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