Package com.okta.sdk.resource.api

Class UserTypeApi

java.lang.Object
com.okta.sdk.resource.api.UserTypeApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T08:35:59.300824-05:00[America/Chicago]", comments="Generator version: 7.8.0") public class UserTypeApi extends Object

  • Constructor Details

    • UserTypeApi

      public UserTypeApi()

    • UserTypeApi

      public UserTypeApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createUserType

      public UserType createUserType(CreateUserTypeRequest 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(CreateUserTypeRequest 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. This operation is a full update. > **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. This operation is a full update. > **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. This operation is a partial update. > **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. This operation is a partial update. > **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()