Package com.okta.sdk.resource.model

Class WsFederationApplicationSettingsApplication

java.lang.Object

com.okta.sdk.resource.model.WsFederationApplicationSettingsApplication

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 WsFederationApplicationSettingsApplication
extends Object
implements Serializable

WsFederationApplicationSettingsApplication

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WsFederationApplicationSettingsApplication.GroupValueFormatEnum	Specifies the WS-Fed assertion attribute value for filtered groups.
static enum	WsFederationApplicationSettingsApplication.UsernameAttributeEnum	Specifies additional username attribute statements to include in the WS-Fed assertion

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ATTRIBUTE_STATEMENTS
static final String	JSON_PROPERTY_AUDIENCE_RESTRICTION
static final String	JSON_PROPERTY_AUTHN_CONTEXT_CLASS_REF
static final String	JSON_PROPERTY_GROUP_FILTER
static final String	JSON_PROPERTY_GROUP_NAME
static final String	JSON_PROPERTY_GROUP_VALUE_FORMAT
static final String	JSON_PROPERTY_NAME_I_D_FORMAT
static final String	JSON_PROPERTY_REALM
static final String	JSON_PROPERTY_SITE_U_R_L
static final String	JSON_PROPERTY_USERNAME_ATTRIBUTE
static final String	JSON_PROPERTY_W_REPLY_OVERRIDE
static final String	JSON_PROPERTY_W_REPLY_U_R_L

Constructor Summary

Constructors

Constructor	Description
WsFederationApplicationSettingsApplication()

Method Summary

Modifier and Type	Method	Description
WsFederationApplicationSettingsApplication	attributeStatements(String attributeStatements)
WsFederationApplicationSettingsApplication	audienceRestriction(String audienceRestriction)
WsFederationApplicationSettingsApplication	authnContextClassRef(String authnContextClassRef)
boolean	equals(Object o)
String	getAttributeStatements()	You can federate user attributes such as Okta profile fields, LDAP, Active Directory, and Workday values.
String	getAudienceRestriction()	The entity ID of the SP.
String	getAuthnContextClassRef()	Identifies the SAML authentication context class for the assertion's authentication statement
String	getGroupFilter()	A regular expression that filters for the User Groups you want included with the `groupName` attribute.
String	getGroupName()	The group name to include in the WS-Fed response attribute statement.
WsFederationApplicationSettingsApplication.GroupValueFormatEnum	getGroupValueFormat()	Specifies the WS-Fed assertion attribute value for filtered groups.
String	getNameIDFormat()	The username format that you send in the WS-Fed response
String	getRealm()	The uniform resource identifier (URI) of the WS-Fed app that's used to share resources securely within a domain.
String	getSiteURL()	Launch URL for the web app
WsFederationApplicationSettingsApplication.UsernameAttributeEnum	getUsernameAttribute()	Specifies additional username attribute statements to include in the WS-Fed assertion
Boolean	getwReplyOverride()	Enables a web app to override the `wReplyURL` URL with a reply parameter.
String	getwReplyURL()	The WS-Fed SP endpoint where your users sign in
WsFederationApplicationSettingsApplication	groupFilter(String groupFilter)
WsFederationApplicationSettingsApplication	groupName(String groupName)
WsFederationApplicationSettingsApplication	groupValueFormat(WsFederationApplicationSettingsApplication.GroupValueFormatEnum groupValueFormat)
int	hashCode()
WsFederationApplicationSettingsApplication	nameIDFormat(String nameIDFormat)
WsFederationApplicationSettingsApplication	realm(String realm)
void	setAttributeStatements(String attributeStatements)
void	setAudienceRestriction(String audienceRestriction)
void	setAuthnContextClassRef(String authnContextClassRef)
void	setGroupFilter(String groupFilter)
void	setGroupName(String groupName)
void	setGroupValueFormat(WsFederationApplicationSettingsApplication.GroupValueFormatEnum groupValueFormat)
void	setNameIDFormat(String nameIDFormat)
void	setRealm(String realm)
void	setSiteURL(String siteURL)
void	setUsernameAttribute(WsFederationApplicationSettingsApplication.UsernameAttributeEnum usernameAttribute)
void	setwReplyOverride(Boolean wReplyOverride)
void	setwReplyURL(String wReplyURL)
WsFederationApplicationSettingsApplication	siteURL(String siteURL)
String	toString()
WsFederationApplicationSettingsApplication	usernameAttribute(WsFederationApplicationSettingsApplication.UsernameAttributeEnum usernameAttribute)
WsFederationApplicationSettingsApplication	wReplyOverride(Boolean wReplyOverride)
WsFederationApplicationSettingsApplication	wReplyURL(String wReplyURL)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ATTRIBUTE_STATEMENTS

public static final String JSON_PROPERTY_ATTRIBUTE_STATEMENTS

See Also:

• Constant Field Values

JSON_PROPERTY_AUDIENCE_RESTRICTION

public static final String JSON_PROPERTY_AUDIENCE_RESTRICTION

See Also:

• Constant Field Values

JSON_PROPERTY_AUTHN_CONTEXT_CLASS_REF

public static final String JSON_PROPERTY_AUTHN_CONTEXT_CLASS_REF

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_FILTER

public static final String JSON_PROPERTY_GROUP_FILTER

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_NAME

public static final String JSON_PROPERTY_GROUP_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_VALUE_FORMAT

public static final String JSON_PROPERTY_GROUP_VALUE_FORMAT

See Also:

• Constant Field Values

JSON_PROPERTY_NAME_I_D_FORMAT

public static final String JSON_PROPERTY_NAME_I_D_FORMAT

See Also:

• Constant Field Values

JSON_PROPERTY_REALM

public static final String JSON_PROPERTY_REALM

See Also:

• Constant Field Values

JSON_PROPERTY_SITE_U_R_L

public static final String JSON_PROPERTY_SITE_U_R_L

See Also:

• Constant Field Values

JSON_PROPERTY_USERNAME_ATTRIBUTE

public static final String JSON_PROPERTY_USERNAME_ATTRIBUTE

See Also:

• Constant Field Values

JSON_PROPERTY_W_REPLY_OVERRIDE

public static final String JSON_PROPERTY_W_REPLY_OVERRIDE

See Also:

• Constant Field Values

JSON_PROPERTY_W_REPLY_U_R_L

public static final String JSON_PROPERTY_W_REPLY_U_R_L

See Also:

• Constant Field Values

Constructor Details

WsFederationApplicationSettingsApplication

public WsFederationApplicationSettingsApplication()

Method Details

attributeStatements

public WsFederationApplicationSettingsApplication attributeStatements(String attributeStatements)

getAttributeStatements

@Nullable
public String getAttributeStatements()

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.

Returns:

attributeStatements

setAttributeStatements

public void setAttributeStatements(String attributeStatements)

audienceRestriction

public WsFederationApplicationSettingsApplication audienceRestriction(String audienceRestriction)

getAudienceRestriction

@Nonnull
public String getAudienceRestriction()

The entity ID of the SP. Use the entity ID value exactly as provided by the SP.

Returns:

audienceRestriction

setAudienceRestriction

public void setAudienceRestriction(String audienceRestriction)

authnContextClassRef

public WsFederationApplicationSettingsApplication authnContextClassRef(String authnContextClassRef)

getAuthnContextClassRef

@Nonnull
public String getAuthnContextClassRef()

Identifies the SAML authentication context class for the assertion's authentication statement

Returns:

authnContextClassRef

setAuthnContextClassRef

public void setAuthnContextClassRef(String authnContextClassRef)

groupFilter

public WsFederationApplicationSettingsApplication groupFilter(String groupFilter)

getGroupFilter

@Nullable
public String getGroupFilter()

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.

Returns:

groupFilter

setGroupFilter

public void setGroupFilter(String groupFilter)

groupName

public WsFederationApplicationSettingsApplication groupName(String groupName)

getGroupName

@Nullable
public String getGroupName()

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.

Returns:

groupName

setGroupName

public void setGroupName(String groupName)

groupValueFormat

public WsFederationApplicationSettingsApplication groupValueFormat(WsFederationApplicationSettingsApplication.GroupValueFormatEnum groupValueFormat)

getGroupValueFormat

@Nonnull
public WsFederationApplicationSettingsApplication.GroupValueFormatEnum getGroupValueFormat()

Specifies the WS-Fed assertion attribute value for filtered groups. This attribute is only applied to Active Directory groups.

Returns:

groupValueFormat

setGroupValueFormat

public void setGroupValueFormat(WsFederationApplicationSettingsApplication.GroupValueFormatEnum groupValueFormat)

nameIDFormat

public WsFederationApplicationSettingsApplication nameIDFormat(String nameIDFormat)

getNameIDFormat

@Nonnull
public String getNameIDFormat()

The username format that you send in the WS-Fed response

Returns:

nameIDFormat

setNameIDFormat

public void setNameIDFormat(String nameIDFormat)

realm

public WsFederationApplicationSettingsApplication realm(String realm)

getRealm

@Nullable
public String getRealm()

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).

Returns:

realm

setRealm

public void setRealm(String realm)

siteURL

public WsFederationApplicationSettingsApplication siteURL(String siteURL)

getSiteURL

@Nonnull
public String getSiteURL()

Launch URL for the web app

Returns:

siteURL

setSiteURL

public void setSiteURL(String siteURL)

usernameAttribute

public WsFederationApplicationSettingsApplication usernameAttribute(WsFederationApplicationSettingsApplication.UsernameAttributeEnum usernameAttribute)

getUsernameAttribute

@Nonnull
public WsFederationApplicationSettingsApplication.UsernameAttributeEnum getUsernameAttribute()

Specifies additional username attribute statements to include in the WS-Fed assertion

Returns:

usernameAttribute

setUsernameAttribute

public void setUsernameAttribute(WsFederationApplicationSettingsApplication.UsernameAttributeEnum usernameAttribute)

wReplyOverride

public WsFederationApplicationSettingsApplication wReplyOverride(Boolean wReplyOverride)

getwReplyOverride

@Nullable
public Boolean getwReplyOverride()

Enables a web app to override the `wReplyURL` URL with a reply parameter.

Returns:

wReplyOverride

setwReplyOverride

public void setwReplyOverride(Boolean wReplyOverride)

wReplyURL

public WsFederationApplicationSettingsApplication wReplyURL(String wReplyURL)

getwReplyURL

@Nonnull
public String getwReplyURL()

The WS-Fed SP endpoint where your users sign in

Returns:

wReplyURL

setwReplyURL

public void setwReplyURL(String wReplyURL)

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