docs.WsFederationApplicationSettingsApplication.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: 23.0.1

Show newest version



# WsFederationApplicationSettingsApplication


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**attributeStatements** | **String** | You can federate user attributes such as Okta profile fields, LDAP, Active Directory, and Workday values. The SP uses the federated WS-Fed attribute values accordingly. |  [optional] |
|**audienceRestriction** | **String** | The entity ID of the SP. Use the entity ID value exactly as provided by the SP. |  |
|**authnContextClassRef** | **String** | Identifies the SAML authentication context class for the assertion's authentication statement |  |
|**groupFilter** | **String** | A regular expression that filters for the User Groups you want included with the `groupName` attribute. If the matching User Group has a corresponding AD group, then the attribute statement includes the value of the attribute specified by `groupValueFormat`. If the matching User Group doesn't contain a corresponding AD group, then the `groupName` is used in the attribute statement. |  [optional] |
|**groupName** | **String** | The group name to include in the WS-Fed response attribute statement. This property is used in conjunction with the `groupFilter` property.  Groups that are filtered through the `groupFilter` expression are included with the `groupName` in the attribute statement. Any users that belong to the group you've filtered are included in the WS-Fed response attribute statement. |  [optional] |
|**groupValueFormat** | [**GroupValueFormatEnum**](#GroupValueFormatEnum) | Specifies the WS-Fed assertion attribute value for filtered groups. This attribute is only applied to Active Directory groups. |  |
|**nameIDFormat** | **String** | The username format that you send in the WS-Fed response |  |
|**realm** | **String** | The uniform resource identifier (URI) of the WS-Fed app that's used to share resources securely within a domain. It's the identity that's sent to the Okta IdP when signing in. See [Realm name](https://help.okta.com/okta_help.htm?type=oie&id=ext_Apps_Configure_Okta_Template_WS_Federation#Realm). |  [optional] |
|**siteURL** | **String** | Launch URL for the web app |  |
|**usernameAttribute** | [**UsernameAttributeEnum**](#UsernameAttributeEnum) | Specifies additional username attribute statements to include in the WS-Fed assertion |  |
|**wReplyOverride** | **Boolean** | Enables a web app to override the `wReplyURL` URL with a reply parameter. |  [optional] |
|**wReplyURL** | **String** | The WS-Fed SP endpoint where your users sign in |  |



## Enum: GroupValueFormatEnum

| Name | Value |
|---- | -----|
| WINDOWS_DOMAIN_QUALIFIED_NAME | "windowsDomainQualifiedName" |
| SAM_ACCOUNT_NAME | "samAccountName" |
| DN | "dn" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |



## Enum: UsernameAttributeEnum

| Name | Value |
|---- | -----|
| USERNAME | "username" |
| UPN | "upn" |
| UPN_AND_USERNAME | "upnAndUsername" |
| NONE | "none" |
| UNKNOWN_DEFAULT_OPEN_API | "unknown_default_open_api" |


## Implemented Interfaces

* Serializable