Package com.okta.sdk.resource.model

Class ApplicationCredentialsUsernameTemplate

java.lang.Object

com.okta.sdk.resource.model.ApplicationCredentialsUsernameTemplate

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class ApplicationCredentialsUsernameTemplate
extends Object
implements Serializable

The template used to generate the username when the app is assigned through a group or directly to a user

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApplicationCredentialsUsernameTemplate.PushStatusEnum	Determines if the username is pushed to the app on updates for CUSTOM `type`
static enum	ApplicationCredentialsUsernameTemplate.TypeEnum	Type of mapping expression.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_PUSH_STATUS
static final String	JSON_PROPERTY_TEMPLATE
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_USER_SUFFIX

Constructor Summary

Constructors

Constructor	Description
ApplicationCredentialsUsernameTemplate()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ApplicationCredentialsUsernameTemplate.PushStatusEnum	getPushStatus()	Determines if the username is pushed to the app on updates for CUSTOM `type`
String	getTemplate()	Mapping expression used to generate usernames.
ApplicationCredentialsUsernameTemplate.TypeEnum	getType()	Type of mapping expression.
String	getUserSuffix()	An optional suffix appended to usernames for `BUILT_IN` mapping expressions
int	hashCode()
ApplicationCredentialsUsernameTemplate	pushStatus(ApplicationCredentialsUsernameTemplate.PushStatusEnum pushStatus)
void	setPushStatus(ApplicationCredentialsUsernameTemplate.PushStatusEnum pushStatus)
void	setTemplate(String template)
void	setType(ApplicationCredentialsUsernameTemplate.TypeEnum type)
void	setUserSuffix(String userSuffix)
ApplicationCredentialsUsernameTemplate	template(String template)
String	toString()
ApplicationCredentialsUsernameTemplate	type(ApplicationCredentialsUsernameTemplate.TypeEnum type)
ApplicationCredentialsUsernameTemplate	userSuffix(String userSuffix)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_PUSH_STATUS

public static final String JSON_PROPERTY_PUSH_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_TEMPLATE

public static final String JSON_PROPERTY_TEMPLATE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_USER_SUFFIX

public static final String JSON_PROPERTY_USER_SUFFIX

See Also:

• Constant Field Values

Constructor Details

ApplicationCredentialsUsernameTemplate

public ApplicationCredentialsUsernameTemplate()

Method Details

pushStatus

public ApplicationCredentialsUsernameTemplate pushStatus(ApplicationCredentialsUsernameTemplate.PushStatusEnum pushStatus)

getPushStatus

@Nullable
public ApplicationCredentialsUsernameTemplate.PushStatusEnum getPushStatus()

Determines if the username is pushed to the app on updates for CUSTOM `type`

Returns:

pushStatus

setPushStatus

public void setPushStatus(ApplicationCredentialsUsernameTemplate.PushStatusEnum pushStatus)

template

public ApplicationCredentialsUsernameTemplate template(String template)

getTemplate

@Nullable
public String getTemplate()

Mapping expression used to generate usernames. The following are supported mapping expressions that are used with the `BUILT_IN` template type: | Name | Template Expression | | ------------------------------- | ---------------------------------------------- | | AD Employee ID | `${source.employeeID}` | | AD SAM Account Name | `${source.samAccountName}` | | AD SAM Account Name (lowercase) | `${fn:toLowerCase(source.samAccountName)}` | | AD User Principal Name | `${source.userName}` | | AD User Principal Name prefix | `${fn:substringBefore(source.userName, \"@\")}` | | Email | `${source.email}` | | Email (lowercase) | `${fn:toLowerCase(source.email)}` | | Email prefix | `${fn:substringBefore(source.email, \"@\")}` | | LDAP UID + custom suffix | `${source.userName}${instance.userSuffix}` | | Okta username | `${source.login}` | | Okta username prefix | `${fn:substringBefore(source.login, \"@\")}` |

Returns:

template

setTemplate

public void setTemplate(String template)

type

public ApplicationCredentialsUsernameTemplate type(ApplicationCredentialsUsernameTemplate.TypeEnum type)

getType

@Nullable
public ApplicationCredentialsUsernameTemplate.TypeEnum getType()

Type of mapping expression. Empty string is allowed.

Returns:

type

setType

public void setType(ApplicationCredentialsUsernameTemplate.TypeEnum type)

userSuffix

public ApplicationCredentialsUsernameTemplate userSuffix(String userSuffix)

getUserSuffix

@Nullable
public String getUserSuffix()

An optional suffix appended to usernames for `BUILT_IN` mapping expressions

Returns:

userSuffix

setUserSuffix

public void setUserSuffix(String userSuffix)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object