com.okta.sdk.resource.identity.provider

Interface IdentityProvider

All Superinterfaces:

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

All Known Implementing Classes:

DefaultIdentityProvider

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface IdentityProvider
extends ExtensibleResource, Deletable

IdentityProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdentityProvider.IssuerModeEnum Enum issuerMode
static class	IdentityProvider.StatusEnum Enum status
static class	IdentityProvider.TypeValues

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

Map.Entry<K,V>

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()
Protocol	getProtocol()
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 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

Method Detail

getLinks

Map<String,Object> getLinks()

getCreated

Date getCreated()

getId

String getId()

getIssuerMode

IdentityProvider.IssuerModeEnum getIssuerMode()

setIssuerMode

IdentityProvider setIssuerMode(IdentityProvider.IssuerModeEnum issuerMode)

getLastUpdated

Date getLastUpdated()

getName

String getName()

setName

IdentityProvider setName(String name)

getPolicy

IdentityProviderPolicy getPolicy()

setPolicy

IdentityProvider setPolicy(IdentityProviderPolicy policy)

getProtocol

Protocol getProtocol()

setProtocol

IdentityProvider setProtocol(Protocol protocol)

getStatus

IdentityProvider.StatusEnum getStatus()

setStatus

IdentityProvider setStatus(IdentityProvider.StatusEnum status)

getType

String getType()

setType

IdentityProvider setType(String type)

getUser

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

Fetches a linked IdP user by ID

Parameters:

userId - (required)

Returns:

IdentityProviderApplicationUser

getSigningCsr

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

Gets a specific Certificate Signing Request model by id

Parameters:

csrId - (required)

Returns:

Csr

delete

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

Delete Identity Provider Removes an IdP from your organization.

Specified by:

delete in interface Deletable

generateCsr

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

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

Parameters:

metadata - (required)

Returns:

Csr

activate

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

Activate Identity Provider Activates an inactive IdP.

Returns:

IdentityProvider

linkUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/idps/{idpId}/users/{userId}")
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

Parameters:

userId - (required)

userIdentityProviderLinkRequest - (required)

Returns:

IdentityProviderApplicationUser

listSocialAuthTokens

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}/credentials/tokens")
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.

Parameters:

userId - (required)

Returns:

SocialAuthTokenList

listSigningKeys

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

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

Returns:

JsonWebKeyList

deleteSigningCsr

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

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

Parameters:

csrId - (required)

getSigningKey

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

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

Parameters:

keyId - (required)

Returns:

JsonWebKey

update

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

Update Identity Provider Updates the configuration for an IdP.

Parameters:

identityProvider - (required)

Returns:

IdentityProvider

generateSigningKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/generate")
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

Parameters:

validityYears - expiry of the IdP Key Credential (required)

Returns:

JsonWebKey

listUsers

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

Find Users Find all the users linked to an identity provider

Returns:

IdentityProviderApplicationUserList

unlinkUser

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

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

Parameters:

userId - (required)

listSigningCsrs

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

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

Returns:

CsrList

deactivate

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

Deactivate Identity Provider Deactivates an active IdP.

Returns:

IdentityProvider

cloneKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone")
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

Parameters:

keyId - (required)

targetIdpId - (required)

Returns:

JsonWebKey