Package org.apereo.cas.configuration.model.support.okta

Class OktaPrincipalProvisioningProperties

java.lang.Object

org.apereo.cas.configuration.model.support.okta.BaseOktaProperties

org.apereo.cas.configuration.model.support.okta.BaseOktaApiProperties

org.apereo.cas.configuration.model.support.okta.OktaPrincipalProvisioningProperties

All Implemented Interfaces:

Serializable

@RequiresModule(name="cas-server-support-okta-authentication")
public class OktaPrincipalProvisioningProperties
extends BaseOktaApiProperties

This is OktaPrincipalProvisioningProperties.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OktaPrincipalProvisioningProperties()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributeMappings()	Map of attributes that optionally may be used to control the names of the attributes to Okta that form the user profile.
boolean	isEnabled()	Whether or not provisioning should be enabled with Okta.
OktaPrincipalProvisioningProperties	setAttributeMappings(Map<String,String> attributeMappings)	Map of attributes that optionally may be used to control the names of the attributes to Okta that form the user profile.
OktaPrincipalProvisioningProperties	setEnabled(boolean enabled)	Whether or not provisioning should be enabled with Okta.

Methods inherited from class org.apereo.cas.configuration.model.support.okta.BaseOktaApiProperties

getApiToken, getClientId, getPrivateKey, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getScopes, setApiToken, setClientId, setPrivateKey, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setScopes

Methods inherited from class org.apereo.cas.configuration.model.support.okta.BaseOktaProperties

getConnectionTimeout, getOrder, getOrganizationUrl, setConnectionTimeout, setOrder, setOrganizationUrl

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OktaPrincipalProvisioningProperties

public OktaPrincipalProvisioningProperties()

Method Details

isEnabled

public boolean isEnabled()

Whether or not provisioning should be enabled with Okta.

getAttributeMappings

public Map<String,String> getAttributeMappings()

Map of attributes that optionally may be used to control the names of the attributes to Okta that form the user profile. If an attribute is provided by Okta, such as department, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention department->organization will process the CAS attribute organization and will assign its value to the user profile under department. If no mapping is specified, the okta attribute itself will be used to find the CAS principal attribute value.

setEnabled

public OktaPrincipalProvisioningProperties setEnabled(boolean enabled)

Whether or not provisioning should be enabled with Okta.

Returns:

this.

setAttributeMappings

public OktaPrincipalProvisioningProperties setAttributeMappings(Map<String,String> attributeMappings)

Map of attributes that optionally may be used to control the names of the attributes to Okta that form the user profile. If an attribute is provided by Okta, such as department, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention department->organization will process the CAS attribute organization and will assign its value to the user profile under department. If no mapping is specified, the okta attribute itself will be used to find the CAS principal attribute value.

Returns:

this.