org.openapitools.client.api

Class UserTypeApi

java.lang.Object

org.openapitools.client.api.UserTypeApi

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

Constructor Summary

Constructors

Constructor and Description
UserTypeApi()
UserTypeApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UserType	createUserType(UserType userType) Create a User Type Creates a new User Type.
UserType	createUserType(UserType userType, Map<String,String> additionalHeaders) Create a User Type Creates a new User Type.
void	deleteUserType(String typeId) Delete a User Type Deletes a User Type permanently.
void	deleteUserType(String typeId, Map<String,String> additionalHeaders) Delete a User Type Deletes a User Type permanently.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
UserType	getUserType(String typeId) Retrieve a User Type Retrieves a User Type by ID.
UserType	getUserType(String typeId, Map<String,String> additionalHeaders) Retrieve a User Type Retrieves a User Type by ID.
List<UserType>	listUserTypes() List all User Types Lists all User Types in your org
List<UserType>	listUserTypes(Map<String,String> additionalHeaders) List all User Types Lists all User Types in your org
UserType	replaceUserType(String typeId, UserTypePutRequest userType) Replace a User Type Replaces an existing User Type.
UserType	replaceUserType(String typeId, UserTypePutRequest userType, Map<String,String> additionalHeaders) Replace a User Type Replaces an existing User Type.
void	setApiClient(ApiClient apiClient)
UserType	updateUserType(String typeId, UserTypePostRequest userType) Update a User Type Updates an existing User Type.
UserType	updateUserType(String typeId, UserTypePostRequest userType, Map<String,String> additionalHeaders) Update a User Type Updates an existing User Type.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserTypeApi

public UserTypeApi()

UserTypeApi

public UserTypeApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createUserType

public UserType createUserType(UserType userType)
                        throws ApiException

Create a User Type Creates a new User Type. Okta automatically creates a `default` User Type for your org. You may add up to nine additional User Types. > **Note**: New User Types are based on the current default schema template. Modifications to this schema do not automatically propagate to previously created User Types.

Parameters:

userType - (required)

Returns:

UserType

Throws:

ApiException - if fails to make API call

createUserType

public UserType createUserType(UserType userType,
                               Map<String,String> additionalHeaders)
                        throws ApiException

Create a User Type Creates a new User Type. Okta automatically creates a `default` User Type for your org. You may add up to nine additional User Types. > **Note**: New User Types are based on the current default schema template. Modifications to this schema do not automatically propagate to previously created User Types.

Parameters:

userType - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserType

Throws:

ApiException - if fails to make API call

deleteUserType

public void deleteUserType(String typeId)
                    throws ApiException

Delete a User Type Deletes a User Type permanently. > **Note**: You can't delete the default User Type or a User Type that is currently assigned to users.

Parameters:

typeId - (required)

Throws:

ApiException - if fails to make API call

deleteUserType

public void deleteUserType(String typeId,
                           Map<String,String> additionalHeaders)
                    throws ApiException

Delete a User Type Deletes a User Type permanently. > **Note**: You can't delete the default User Type or a User Type that is currently assigned to users.

Parameters:

typeId - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getUserType

public UserType getUserType(String typeId)
                     throws ApiException

Retrieve a User Type Retrieves a User Type by ID. Use `default` to fetch the default User Type.

Parameters:

typeId - (required)

Returns:

UserType

Throws:

ApiException - if fails to make API call

getUserType

public UserType getUserType(String typeId,
                            Map<String,String> additionalHeaders)
                     throws ApiException

Retrieve a User Type Retrieves a User Type by ID. Use `default` to fetch the default User Type.

Parameters:

typeId - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserType

Throws:

ApiException - if fails to make API call

listUserTypes

public List<UserType> listUserTypes()
                             throws ApiException

List all User Types Lists all User Types in your org

Returns:

List<UserType>

Throws:

ApiException - if fails to make API call

listUserTypes

public List<UserType> listUserTypes(Map<String,String> additionalHeaders)
                             throws ApiException

List all User Types Lists all User Types in your org

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<UserType>

Throws:

ApiException - if fails to make API call

replaceUserType

public UserType replaceUserType(String typeId,
                                UserTypePutRequest userType)
                         throws ApiException

Replace a User Type Replaces an existing User Type. > **Note**: The `name` of an existing User Type can't be changed, but must be part of the request body. You can only replace the `displayName` and `description` elements.

Parameters:

typeId - (required)

userType - (optional)

Returns:

UserType

Throws:

ApiException - if fails to make API call

replaceUserType

public UserType replaceUserType(String typeId,
                                UserTypePutRequest userType,
                                Map<String,String> additionalHeaders)
                         throws ApiException

Replace a User Type Replaces an existing User Type. > **Note**: The `name` of an existing User Type can't be changed, but must be part of the request body. You can only replace the `displayName` and `description` elements.

Parameters:

typeId - (required)

userType - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

UserType

Throws:

ApiException - if fails to make API call

updateUserType

public UserType updateUserType(String typeId,
                               UserTypePostRequest userType)
                        throws ApiException

Update a User Type Updates an existing User Type. > **Note**: You can only update the `displayName` and `description` elements. The `name` of an existing User Type can't be changed.

Parameters:

typeId - (required)

userType - (required)

Returns:

UserType

Throws:

ApiException - if fails to make API call

updateUserType

public UserType updateUserType(String typeId,
                               UserTypePostRequest userType,
                               Map<String,String> additionalHeaders)
                        throws ApiException

Update a User Type Updates an existing User Type. > **Note**: You can only update the `displayName` and `description` elements. The `name` of an existing User Type can't be changed.

Parameters:

typeId - (required)

userType - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UserType

Throws:

ApiException - if fails to make API call

getObjectMapper

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