docs.ApplicationCredentialsUsernameTemplate.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

There is a newer version: 21.0.0

Show newest version



# ApplicationCredentialsUsernameTemplate

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

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**pushStatus** | [**PushStatusEnum**](#PushStatusEnum) | Determines if the username is pushed to the app on updates for CUSTOM `type` |  [optional] |
|**template** | **String** | 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, \"@\")}`     | |  [optional] |
|**type** | [**TypeEnum**](#TypeEnum) | Type of mapping expression. Empty string is allowed. |  [optional] |
|**userSuffix** | **String** | An optional suffix appended to usernames for `BUILT_IN` mapping expressions |  [optional] |



## Enum: PushStatusEnum

| Name | Value |
|---- | -----|
| PUSH | "PUSH" |
| DONT_PUSH | "DONT_PUSH" |
| NOT_CONFIGURED | "NOT_CONFIGURED" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: TypeEnum

| Name | Value |
|---- | -----|
| NONE | "NONE" |
| BUILT_IN | "BUILT_IN" |
| CUSTOM | "CUSTOM" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable