com.okta.sdk.resource.user.type

Interface UserType

All Superinterfaces:

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

All Known Implementing Classes:

DefaultUserType

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

UserType

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	delete() Deletes a User Type permanently.
Date	getCreated()
String	getCreatedBy()
Boolean	getDefault()
String	getDescription()
String	getDisplayName()
String	getId()
Date	getLastUpdated()
String	getLastUpdatedBy()
Map<String,Object>	getLinks()
String	getName()
UserType	replaceUserType(String typeId, UserType userType) Replace an existing User Type
UserType	setDescription(String description)
UserType	setDisplayName(String displayName)
UserType	setId(String id)
UserType	setName(String name)
UserType	update() Updates an existing User 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

getLinks

Map<String,Object> getLinks()

getCreated

Date getCreated()

getCreatedBy

String getCreatedBy()

getDefault

Boolean getDefault()

getDescription

String getDescription()

setDescription

UserType setDescription(String description)

getDisplayName

String getDisplayName()

setDisplayName

UserType setDisplayName(String displayName)

getId

String getId()

setId

UserType setId(String id)

getLastUpdated

Date getLastUpdated()

getLastUpdatedBy

String getLastUpdatedBy()

getName

String getName()

setName

UserType setName(String name)

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/meta/types/user/{typeId}")
void delete()

Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users

Specified by:

delete in interface Deletable

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/types/user/{typeId}")
UserType update()

Updates an existing User Type

Returns:

UserType

replaceUserType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/meta/types/user/{typeId}")
UserType replaceUserType(String typeId,
                                                                                                                                                                                                              UserType userType)

Replace an existing User Type

Parameters:

typeId - (required)

userType - (required)

Returns:

UserType