com.okta.sdk.impl.resource.identity.provider

Class DefaultIdentityProvider

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<IdentityProvider>

com.okta.sdk.impl.resource.identity.provider.DefaultIdentityProvider

All Implemented Interfaces:

Deletable, ExtensibleResource, IdentityProvider, PropertyRetriever, Resource, Saveable<IdentityProvider>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultIdentityProvider
extends AbstractInstanceResource<IdentityProvider>
implements IdentityProvider

IdentityProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.okta.sdk.resource.identity.provider.IdentityProvider

IdentityProvider.IssuerModeEnum, IdentityProvider.StatusEnum, IdentityProvider.TypeValues

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultIdentityProvider(InternalDataStore dataStore)
DefaultIdentityProvider(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
IdentityProvider	activate() Activate Identity Provider Activates an inactive IdP.
JsonWebKey	cloneKey(String keyId, String targetIdpId) Clone Signing Key Credential for IdP Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
IdentityProvider	deactivate() Deactivate Identity Provider Deactivates an active IdP.
void	delete() Delete Identity Provider Removes an IdP from your organization.
void	deleteSigningCsr(String csrId) Revoke a Certificate Signing Request and delete the key pair from the IdP
Csr	generateCsr(CsrMetadata metadata) Generate Certificate Signing Request for IdP Generates a new key pair and returns a Certificate Signing Request for it.
JsonWebKey	generateSigningKey(Integer validityYears) Generate New IdP Signing Key Credential Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
Date	getCreated()
String	getId()
IdentityProvider.IssuerModeEnum	getIssuerMode()
Date	getLastUpdated()
Map<String,Object>	getLinks()
String	getName()
IdentityProviderPolicy	getPolicy()
Map<String,Property>	getPropertyDescriptors()
Protocol	getProtocol()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
Csr	getSigningCsr(String csrId) Gets a specific Certificate Signing Request model by id
JsonWebKey	getSigningKey(String keyId) Get Signing Key Credential for IdP Gets a specific IdP Key Credential by `kid`
IdentityProvider.StatusEnum	getStatus()
String	getType()
IdentityProviderApplicationUser	getUser(String userId) Fetches a linked IdP user by ID
IdentityProviderApplicationUser	linkUser(String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) Link a user to a Social IdP without a transaction Links an Okta user to an existing Social Identity Provider.
CsrList	listSigningCsrs() List Certificate Signing Requests for IdP Enumerates Certificate Signing Requests for an IdP
JsonWebKeyList	listSigningKeys() List Signing Key Credentials for IdP Enumerates signing key credentials for an IdP
SocialAuthTokenList	listSocialAuthTokens(String userId) Social Authentication Token Operation Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.
IdentityProviderApplicationUserList	listUsers() Find Users Find all the users linked to an identity provider
IdentityProvider	setIssuerMode(IdentityProvider.IssuerModeEnum issuerMode)
IdentityProvider	setName(String name)
IdentityProvider	setPolicy(IdentityProviderPolicy policy)
IdentityProvider	setProtocol(Protocol protocol)
IdentityProvider	setStatus(IdentityProvider.StatusEnum status)
IdentityProvider	setType(String type)
void	unlinkUser(String userId) Unlink User from IdP Removes the link between the Okta user and the IdP user.
IdentityProvider	update(IdentityProvider identityProvider) Update Identity Provider Updates the configuration for an IdP.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultIdentityProvider

public DefaultIdentityProvider(InternalDataStore dataStore)

DefaultIdentityProvider

public DefaultIdentityProvider(InternalDataStore dataStore,
                               Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<IdentityProvider>

Returns:

The type of resource this class represents.

getLinks

public Map<String,Object> getLinks()

Specified by:

getLinks in interface IdentityProvider

getCreated

public Date getCreated()

Specified by:

getCreated in interface IdentityProvider

getId

public String getId()

Specified by:

getId in interface IdentityProvider

getIssuerMode

public IdentityProvider.IssuerModeEnum getIssuerMode()

Specified by:

getIssuerMode in interface IdentityProvider

setIssuerMode

public IdentityProvider setIssuerMode(IdentityProvider.IssuerModeEnum issuerMode)

Specified by:

setIssuerMode in interface IdentityProvider

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface IdentityProvider

getName

public String getName()

Specified by:

getName in interface IdentityProvider

setName

public IdentityProvider setName(String name)

Specified by:

setName in interface IdentityProvider

getPolicy

public IdentityProviderPolicy getPolicy()

Specified by:

getPolicy in interface IdentityProvider

setPolicy

public IdentityProvider setPolicy(IdentityProviderPolicy policy)

Specified by:

setPolicy in interface IdentityProvider

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in interface IdentityProvider

setProtocol

public IdentityProvider setProtocol(Protocol protocol)

Specified by:

setProtocol in interface IdentityProvider

getStatus

public IdentityProvider.StatusEnum getStatus()

Specified by:

getStatus in interface IdentityProvider

setStatus

public IdentityProvider setStatus(IdentityProvider.StatusEnum status)

Specified by:

setStatus in interface IdentityProvider

getType

public String getType()

Specified by:

getType in interface IdentityProvider

setType

public IdentityProvider setType(String type)

Specified by:

setType in interface IdentityProvider

getUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}")
public IdentityProviderApplicationUser getUser(String userId)

Fetches a linked IdP user by ID

Specified by:

getUser in interface IdentityProvider

Parameters:

userId - (required)

Returns:

IdentityProviderApplicationUser

getSigningCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
public Csr getSigningCsr(String csrId)

Gets a specific Certificate Signing Request model by id

Specified by:

getSigningCsr in interface IdentityProvider

Parameters:

csrId - (required)

Returns:

Csr

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/idps/{idpId}")
public void delete()

Delete Identity Provider Removes an IdP from your organization.

Specified by:

delete in interface Deletable

Specified by:

delete in interface IdentityProvider

Overrides:

delete in class AbstractInstanceResource<IdentityProvider>

generateCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/csrs")
public Csr generateCsr(CsrMetadata metadata)

Generate Certificate Signing Request for IdP Generates a new key pair and returns a Certificate Signing Request for it.

Specified by:

generateCsr in interface IdentityProvider

Parameters:

metadata - (required)

Returns:

Csr

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/lifecycle/activate")
public IdentityProvider activate()

Activate Identity Provider Activates an inactive IdP.

Specified by:

activate in interface IdentityProvider

Returns:

IdentityProvider

linkUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/users/{userId}")
public IdentityProviderApplicationUser linkUser(String userId,
                                                                                                                                                                                                                                          UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)

Link a user to a Social IdP without a transaction Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type

Specified by:

linkUser in interface IdentityProvider

Parameters:

userId - (required)

userIdentityProviderLinkRequest - (required)

Returns:

IdentityProviderApplicationUser

listSocialAuthTokens

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}/credentials/tokens")
public SocialAuthTokenList listSocialAuthTokens(String userId)

Social Authentication Token Operation Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

Specified by:

listSocialAuthTokens in interface IdentityProvider

Parameters:

userId - (required)

Returns:

SocialAuthTokenList

listSigningKeys

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/keys")
public JsonWebKeyList listSigningKeys()

List Signing Key Credentials for IdP Enumerates signing key credentials for an IdP

Specified by:

listSigningKeys in interface IdentityProvider

Returns:

JsonWebKeyList

deleteSigningCsr

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
public void deleteSigningCsr(String csrId)

Revoke a Certificate Signing Request and delete the key pair from the IdP

Specified by:

deleteSigningCsr in interface IdentityProvider

Parameters:

csrId - (required)

getSigningKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/keys/{keyId}")
public JsonWebKey getSigningKey(String keyId)

Get Signing Key Credential for IdP Gets a specific IdP Key Credential by `kid`

Specified by:

getSigningKey in interface IdentityProvider

Parameters:

keyId - (required)

Returns:

JsonWebKey

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/idps/{idpId}")
public IdentityProvider update(IdentityProvider identityProvider)

Update Identity Provider Updates the configuration for an IdP.

Specified by:

update in interface IdentityProvider

Parameters:

identityProvider - (required)

Returns:

IdentityProvider

generateSigningKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/generate")
public JsonWebKey generateSigningKey(Integer validityYears)

Generate New IdP Signing Key Credential Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP

Specified by:

generateSigningKey in interface IdentityProvider

Parameters:

validityYears - expiry of the IdP Key Credential (required)

Returns:

JsonWebKey

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/users")
public IdentityProviderApplicationUserList listUsers()

Find Users Find all the users linked to an identity provider

Specified by:

listUsers in interface IdentityProvider

Returns:

IdentityProviderApplicationUserList

unlinkUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/idps/{idpId}/users/{userId}")
public void unlinkUser(String userId)

Unlink User from IdP Removes the link between the Okta user and the IdP user.

Specified by:

unlinkUser in interface IdentityProvider

Parameters:

userId - (required)

listSigningCsrs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/csrs")
public CsrList listSigningCsrs()

List Certificate Signing Requests for IdP Enumerates Certificate Signing Requests for an IdP

Specified by:

listSigningCsrs in interface IdentityProvider

Returns:

CsrList

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/lifecycle/deactivate")
public IdentityProvider deactivate()

Deactivate Identity Provider Deactivates an active IdP.

Specified by:

deactivate in interface IdentityProvider

Returns:

IdentityProvider

cloneKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone")
public JsonWebKey cloneKey(String keyId,
                                                                                                                                                                                                                                     String targetIdpId)

Clone Signing Key Credential for IdP Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP

Specified by:

cloneKey in interface IdentityProvider

Parameters:

keyId - (required)

targetIdpId - (required)

Returns:

JsonWebKey