org.openapitools.client.api

Class IdentityProviderApi

java.lang.Object

org.openapitools.client.api.IdentityProviderApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.IdentityProviderApi")
public class IdentityProviderApi
extends Object

Constructor Summary

Constructors

Constructor and Description
IdentityProviderApi()
IdentityProviderApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
IdentityProvider	activateIdentityProvider(String idpId) Activate an Identity Provider Activates an inactive IdP
PagedList	activateIdentityProviderWithPaginationInfo(String idpId) Activate an Identity Provider Activates an inactive IdP
JsonWebKey	cloneIdentityProviderKey(String idpId, String keyId, String targetIdpId) Clone a Signing Credential Key Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
PagedList	cloneIdentityProviderKeyWithPaginationInfo(String idpId, String keyId, String targetIdpId) Clone a Signing Credential Key Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
<T> T	createIdentityProvider(Class<?> T, IdentityProvider identityProvider) Create an Identity Provider Creates a new identity provider integration
IdentityProvider	createIdentityProvider(IdentityProvider identityProvider) Create an Identity Provider Creates a new identity provider integration
<T> T	createIdentityProviderKey(Class<?> T, JsonWebKey jsonWebKey) Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.
JsonWebKey	createIdentityProviderKey(JsonWebKey jsonWebKey) Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.
PagedList	createIdentityProviderKeyWithPaginationInfo(JsonWebKey jsonWebKey) Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.
PagedList	createIdentityProviderWithPaginationInfo(IdentityProvider identityProvider) Create an Identity Provider Creates a new identity provider integration
IdentityProvider	deactivateIdentityProvider(String idpId) Deactivate an Identity Provider Deactivates an active IdP
PagedList	deactivateIdentityProviderWithPaginationInfo(String idpId) Deactivate an Identity Provider Deactivates an active IdP
void	deleteIdentityProvider(String idpId) Delete an Identity Provider Deletes an identity provider integration by `idpId`
void	deleteIdentityProviderKey(String keyId) Delete a Signing Credential Key Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP
<T> T	generateCsrForIdentityProvider(Class<?> T, String idpId, CsrMetadata metadata) Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request for it
Csr	generateCsrForIdentityProvider(String idpId, CsrMetadata metadata) Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request for it
PagedList	generateCsrForIdentityProviderWithPaginationInfo(String idpId, CsrMetadata metadata) Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request for it
JsonWebKey	generateIdentityProviderSigningKey(String idpId, Integer validityYears) Generate a new Signing Credential Key Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
PagedList	generateIdentityProviderSigningKeyWithPaginationInfo(String idpId, Integer validityYears) Generate a new Signing Credential Key Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP
ApiClient	getApiClient()
Csr	getCsrForIdentityProvider(String idpId, String csrId) Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id
PagedList	getCsrForIdentityProviderWithPaginationInfo(String idpId, String csrId) Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id
IdentityProvider	getIdentityProvider(String idpId) Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`
IdentityProviderApplicationUser	getIdentityProviderApplicationUser(String idpId, String userId) Retrieve a User Retrieves a linked IdP user by ID
PagedList	getIdentityProviderApplicationUserWithPaginationInfo(String idpId, String userId) Retrieve a User Retrieves a linked IdP user by ID
JsonWebKey	getIdentityProviderKey(String keyId) Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`
PagedList	getIdentityProviderKeyWithPaginationInfo(String keyId) Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`
JsonWebKey	getIdentityProviderSigningKey(String idpId, String keyId) Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`
PagedList	getIdentityProviderSigningKeyWithPaginationInfo(String idpId, String keyId) Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`
PagedList	getIdentityProviderWithPaginationInfo(String idpId) Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`
<T> T	linkUserToIdentityProvider(Class<?> T, String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) Link a User to a Social IdP Links an Okta user to an existing Social Identity Provider.
IdentityProviderApplicationUser	linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) Link a User to a Social IdP Links an Okta user to an existing Social Identity Provider.
PagedList	linkUserToIdentityProviderWithPaginationInfo(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) Link a User to a Social IdP Links an Okta user to an existing Social Identity Provider.
List<Csr>	listCsrsForIdentityProvider(String idpId) List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
PagedList	listCsrsForIdentityProviderWithPaginationInfo(String idpId) List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
List<IdentityProviderApplicationUser>	listIdentityProviderApplicationUsers(String idpId) List all Users Find all the users linked to an identity provider
PagedList	listIdentityProviderApplicationUsersWithPaginationInfo(String idpId) List all Users Find all the users linked to an identity provider
List<JsonWebKey>	listIdentityProviderKeys(String after, Integer limit) List all Credential Keys Lists all IdP key credentials
PagedList	listIdentityProviderKeysWithPaginationInfo(String after, Integer limit) List all Credential Keys Lists all IdP key credentials
List<IdentityProvider>	listIdentityProviders(String q, String after, Integer limit, String type) List all Identity Providers Lists all identity provider integrations with pagination.
List<JsonWebKey>	listIdentityProviderSigningKeys(String idpId) List all Signing Credential Keys Lists all signing key credentials for an IdP
PagedList	listIdentityProviderSigningKeysWithPaginationInfo(String idpId) List all Signing Credential Keys Lists all signing key credentials for an IdP
PagedList	listIdentityProvidersWithPaginationInfo(String q, String after, Integer limit, String type) List all Identity Providers Lists all identity provider integrations with pagination.
List<SocialAuthToken>	listSocialAuthTokens(String idpId, String userId) List all Tokens from a OIDC Identity Provider Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth
PagedList	listSocialAuthTokensWithPaginationInfo(String idpId, String userId) List all Tokens from a OIDC Identity Provider Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth
<T> T	publishCsrForIdentityProvider(Class<?> T, String idpId, String csrId, File body) Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
JsonWebKey	publishCsrForIdentityProvider(String idpId, String csrId, File body) Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
PagedList	publishCsrForIdentityProviderWithPaginationInfo(String idpId, String csrId, File body) Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
<T> T	replaceIdentityProvider(Class<?> T, String idpId, IdentityProvider identityProvider) Replace an Identity Provider Replaces an identity provider integration by `idpId`
IdentityProvider	replaceIdentityProvider(String idpId, IdentityProvider identityProvider) Replace an Identity Provider Replaces an identity provider integration by `idpId`
PagedList	replaceIdentityProviderWithPaginationInfo(String idpId, IdentityProvider identityProvider) Replace an Identity Provider Replaces an identity provider integration by `idpId`
void	revokeCsrForIdentityProvider(String idpId, String csrId) Revoke a Certificate Signing Request Revoke a Certificate Signing Request and delete the key pair from the IdP
void	setApiClient(ApiClient apiClient)
void	unlinkUserFromIdentityProvider(String idpId, String userId) Unlink a User from IdP Unlinks the link between the Okta user and the IdP user

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityProviderApi

public IdentityProviderApi()

IdentityProviderApi

@Autowired
public IdentityProviderApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateIdentityProvider

public IdentityProvider activateIdentityProvider(String idpId)
                                          throws org.springframework.web.client.RestClientException

Activate an Identity Provider Activates an inactive IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

IdentityProvider

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateIdentityProviderWithPaginationInfo

public PagedList activateIdentityProviderWithPaginationInfo(String idpId)
                                                     throws org.springframework.web.client.RestClientException

Activate an Identity Provider Activates an inactive IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

cloneIdentityProviderKey

public JsonWebKey cloneIdentityProviderKey(String idpId,
                                           String keyId,
                                           String targetIdpId)
                                    throws org.springframework.web.client.RestClientException

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

201 - Created

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

keyId - (required)

targetIdpId - (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

cloneIdentityProviderKeyWithPaginationInfo

public PagedList cloneIdentityProviderKeyWithPaginationInfo(String idpId,
                                                            String keyId,
                                                            String targetIdpId)
                                                     throws org.springframework.web.client.RestClientException

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

201 - Created

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

keyId - (required)

targetIdpId - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProvider

public IdentityProvider createIdentityProvider(IdentityProvider identityProvider)
                                        throws org.springframework.web.client.RestClientException

Create an Identity Provider Creates a new identity provider integration

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

identityProvider - (required)

Returns:

IdentityProvider

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProvider

public <T> T createIdentityProvider(Class<?> T,
                                    IdentityProvider identityProvider)
                             throws org.springframework.web.client.RestClientException

Create an Identity Provider Creates a new identity provider integration

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

identityProvider - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProviderWithPaginationInfo

public PagedList createIdentityProviderWithPaginationInfo(IdentityProvider identityProvider)
                                                   throws org.springframework.web.client.RestClientException

Create an Identity Provider Creates a new identity provider integration

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

identityProvider - (required)

Returns:

ResponseEntity<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProviderKey

public JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey)
                                     throws org.springframework.web.client.RestClientException

Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

jsonWebKey - (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProviderKey

public <T> T createIdentityProviderKey(Class<?> T,
                                       JsonWebKey jsonWebKey)
                                throws org.springframework.web.client.RestClientException

Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

jsonWebKey - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createIdentityProviderKeyWithPaginationInfo

public PagedList createIdentityProviderKeyWithPaginationInfo(JsonWebKey jsonWebKey)
                                                      throws org.springframework.web.client.RestClientException

Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

jsonWebKey - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateIdentityProvider

public IdentityProvider deactivateIdentityProvider(String idpId)
                                            throws org.springframework.web.client.RestClientException

Deactivate an Identity Provider Deactivates an active IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

IdentityProvider

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateIdentityProviderWithPaginationInfo

public PagedList deactivateIdentityProviderWithPaginationInfo(String idpId)
                                                       throws org.springframework.web.client.RestClientException

Deactivate an Identity Provider Deactivates an active IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteIdentityProvider

public void deleteIdentityProvider(String idpId)
                            throws org.springframework.web.client.RestClientException

Delete an Identity Provider Deletes an identity provider integration by `idpId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteIdentityProviderKey

public void deleteIdentityProviderKey(String keyId)
                               throws org.springframework.web.client.RestClientException

Delete a Signing Credential Key Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

keyId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

generateCsrForIdentityProvider

public Csr generateCsrForIdentityProvider(String idpId,
                                          CsrMetadata metadata)
                                   throws org.springframework.web.client.RestClientException

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

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

metadata - (required)

Returns:

Csr

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

generateCsrForIdentityProvider

public <T> T generateCsrForIdentityProvider(Class<?> T,
                                            String idpId,
                                            CsrMetadata metadata)
                                     throws org.springframework.web.client.RestClientException

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

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

idpId - (required)

metadata - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

generateCsrForIdentityProviderWithPaginationInfo

public PagedList generateCsrForIdentityProviderWithPaginationInfo(String idpId,
                                                                  CsrMetadata metadata)
                                                           throws org.springframework.web.client.RestClientException

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

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

metadata - (required)

Returns:

ResponseEntity<Csr>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

generateIdentityProviderSigningKey

public JsonWebKey generateIdentityProviderSigningKey(String idpId,
                                                     Integer validityYears)
                                              throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

validityYears - expiry of the IdP Key Credential (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

generateIdentityProviderSigningKeyWithPaginationInfo

public PagedList generateIdentityProviderSigningKeyWithPaginationInfo(String idpId,
                                                                      Integer validityYears)
                                                               throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

validityYears - expiry of the IdP Key Credential (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getCsrForIdentityProvider

public Csr getCsrForIdentityProvider(String idpId,
                                     String csrId)
                              throws org.springframework.web.client.RestClientException

Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

csrId - (required)

Returns:

Csr

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getCsrForIdentityProviderWithPaginationInfo

public PagedList getCsrForIdentityProviderWithPaginationInfo(String idpId,
                                                             String csrId)
                                                      throws org.springframework.web.client.RestClientException

Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

csrId - (required)

Returns:

ResponseEntity<Csr>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProvider

public IdentityProvider getIdentityProvider(String idpId)
                                     throws org.springframework.web.client.RestClientException

Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

IdentityProvider

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderWithPaginationInfo

public PagedList getIdentityProviderWithPaginationInfo(String idpId)
                                                throws org.springframework.web.client.RestClientException

Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderApplicationUser

public IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId,
                                                                          String userId)
                                                                   throws org.springframework.web.client.RestClientException

Retrieve a User Retrieves a linked IdP user by ID

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

Returns:

IdentityProviderApplicationUser

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderApplicationUserWithPaginationInfo

public PagedList getIdentityProviderApplicationUserWithPaginationInfo(String idpId,
                                                                      String userId)
                                                               throws org.springframework.web.client.RestClientException

Retrieve a User Retrieves a linked IdP user by ID

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

Returns:

ResponseEntity<IdentityProviderApplicationUser>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderKey

public JsonWebKey getIdentityProviderKey(String keyId)
                                  throws org.springframework.web.client.RestClientException

Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

keyId - (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderKeyWithPaginationInfo

public PagedList getIdentityProviderKeyWithPaginationInfo(String keyId)
                                                   throws org.springframework.web.client.RestClientException

Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

keyId - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderSigningKey

public JsonWebKey getIdentityProviderSigningKey(String idpId,
                                                String keyId)
                                         throws org.springframework.web.client.RestClientException

Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

keyId - (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getIdentityProviderSigningKeyWithPaginationInfo

public PagedList getIdentityProviderSigningKeyWithPaginationInfo(String idpId,
                                                                 String keyId)
                                                          throws org.springframework.web.client.RestClientException

Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

keyId - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

linkUserToIdentityProvider

public IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId,
                                                                  String userId,
                                                                  UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)
                                                           throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

userIdentityProviderLinkRequest - (required)

Returns:

IdentityProviderApplicationUser

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

linkUserToIdentityProvider

public <T> T linkUserToIdentityProvider(Class<?> T,
                                        String idpId,
                                        String userId,
                                        UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)
                                 throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

idpId - (required)

userId - (required)

userIdentityProviderLinkRequest - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

linkUserToIdentityProviderWithPaginationInfo

public PagedList linkUserToIdentityProviderWithPaginationInfo(String idpId,
                                                              String userId,
                                                              UserIdentityProviderLinkRequest userIdentityProviderLinkRequest)
                                                       throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

userIdentityProviderLinkRequest - (required)

Returns:

ResponseEntity<IdentityProviderApplicationUser>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listCsrsForIdentityProvider

public List<Csr> listCsrsForIdentityProvider(String idpId)
                                      throws org.springframework.web.client.RestClientException

List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

List<Csr>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listCsrsForIdentityProviderWithPaginationInfo

public PagedList listCsrsForIdentityProviderWithPaginationInfo(String idpId)
                                                        throws org.springframework.web.client.RestClientException

List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<List<Csr>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderApplicationUsers

public List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId)
                                                                           throws org.springframework.web.client.RestClientException

List all Users Find all the users linked to an identity provider

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

List<IdentityProviderApplicationUser>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderApplicationUsersWithPaginationInfo

public PagedList listIdentityProviderApplicationUsersWithPaginationInfo(String idpId)
                                                                 throws org.springframework.web.client.RestClientException

List all Users Find all the users linked to an identity provider

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<List<IdentityProviderApplicationUser>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderKeys

public List<JsonWebKey> listIdentityProviderKeys(String after,
                                                 Integer limit)
                                          throws org.springframework.web.client.RestClientException

List all Credential Keys Lists all IdP key credentials

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

after - Specifies the pagination cursor for the next page of keys (optional)

limit - Specifies the number of key results in a page (optional, default to 20)

Returns:

List<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderKeysWithPaginationInfo

public PagedList listIdentityProviderKeysWithPaginationInfo(String after,
                                                            Integer limit)
                                                     throws org.springframework.web.client.RestClientException

List all Credential Keys Lists all IdP key credentials

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

after - Specifies the pagination cursor for the next page of keys (optional)

limit - Specifies the number of key results in a page (optional, default to 20)

Returns:

ResponseEntity<List<JsonWebKey>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderSigningKeys

public List<JsonWebKey> listIdentityProviderSigningKeys(String idpId)
                                                 throws org.springframework.web.client.RestClientException

List all Signing Credential Keys Lists all signing key credentials for an IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

List<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviderSigningKeysWithPaginationInfo

public PagedList listIdentityProviderSigningKeysWithPaginationInfo(String idpId)
                                                            throws org.springframework.web.client.RestClientException

List all Signing Credential Keys Lists all signing key credentials for an IdP

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

Returns:

ResponseEntity<List<JsonWebKey>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProviders

public List<IdentityProvider> listIdentityProviders(String q,
                                                    String after,
                                                    Integer limit,
                                                    String type)
                                             throws org.springframework.web.client.RestClientException

List all Identity Providers Lists all identity provider integrations with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

q - Searches the name property of IdPs for matching value (optional)

after - Specifies the pagination cursor for the next page of IdPs (optional)

limit - Specifies the number of IdP results in a page (optional, default to 20)

type - Filters IdPs by type (optional)

Returns:

List<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listIdentityProvidersWithPaginationInfo

public PagedList listIdentityProvidersWithPaginationInfo(String q,
                                                         String after,
                                                         Integer limit,
                                                         String type)
                                                  throws org.springframework.web.client.RestClientException

List all Identity Providers Lists all identity provider integrations with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

q - Searches the name property of IdPs for matching value (optional)

after - Specifies the pagination cursor for the next page of IdPs (optional)

limit - Specifies the number of IdP results in a page (optional, default to 20)

type - Filters IdPs by type (optional)

Returns:

ResponseEntity<List<IdentityProvider>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSocialAuthTokens

public List<SocialAuthToken> listSocialAuthTokens(String idpId,
                                                  String userId)
                                           throws org.springframework.web.client.RestClientException

List all Tokens from a OIDC Identity Provider Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

Returns:

List<SocialAuthToken>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSocialAuthTokensWithPaginationInfo

public PagedList listSocialAuthTokensWithPaginationInfo(String idpId,
                                                        String userId)
                                                 throws org.springframework.web.client.RestClientException

List all Tokens from a OIDC Identity Provider Lists the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

Returns:

ResponseEntity<List<SocialAuthToken>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

publishCsrForIdentityProvider

public JsonWebKey publishCsrForIdentityProvider(String idpId,
                                                String csrId,
                                                File body)
                                         throws org.springframework.web.client.RestClientException

Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

csrId - (required)

body - (required)

Returns:

JsonWebKey

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

publishCsrForIdentityProvider

public <T> T publishCsrForIdentityProvider(Class<?> T,
                                           String idpId,
                                           String csrId,
                                           File body)
                                    throws org.springframework.web.client.RestClientException

Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

idpId - (required)

csrId - (required)

body - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

publishCsrForIdentityProviderWithPaginationInfo

public PagedList publishCsrForIdentityProviderWithPaginationInfo(String idpId,
                                                                 String csrId,
                                                                 File body)
                                                          throws org.springframework.web.client.RestClientException

Publish a Certificate Signing Request Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

csrId - (required)

body - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceIdentityProvider

public IdentityProvider replaceIdentityProvider(String idpId,
                                                IdentityProvider identityProvider)
                                         throws org.springframework.web.client.RestClientException

Replace an Identity Provider Replaces an identity provider integration by `idpId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

identityProvider - (required)

Returns:

IdentityProvider

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceIdentityProvider

public <T> T replaceIdentityProvider(Class<?> T,
                                     String idpId,
                                     IdentityProvider identityProvider)
                              throws org.springframework.web.client.RestClientException

Replace an Identity Provider Replaces an identity provider integration by `idpId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

idpId - (required)

identityProvider - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceIdentityProviderWithPaginationInfo

public PagedList replaceIdentityProviderWithPaginationInfo(String idpId,
                                                           IdentityProvider identityProvider)
                                                    throws org.springframework.web.client.RestClientException

Replace an Identity Provider Replaces an identity provider integration by `idpId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

identityProvider - (required)

Returns:

ResponseEntity<IdentityProvider>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

revokeCsrForIdentityProvider

public void revokeCsrForIdentityProvider(String idpId,
                                         String csrId)
                                  throws org.springframework.web.client.RestClientException

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

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

csrId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unlinkUserFromIdentityProvider

public void unlinkUserFromIdentityProvider(String idpId,
                                           String userId)
                                    throws org.springframework.web.client.RestClientException

Unlink a User from IdP Unlinks the link between the Okta user and the IdP user

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

idpId - (required)

userId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API