Package com.okta.sdk.resource.api

Class IdentityProviderApi

java.lang.Object
com.okta.sdk.resource.api.IdentityProviderApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class IdentityProviderApi extends Object

  • Constructor Details

    • IdentityProviderApi

      public IdentityProviderApi()

    • IdentityProviderApi

      public IdentityProviderApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateIdentityProvider

      public IdentityProvider activateIdentityProvider(String idpId) throws ApiException
      Activate an Identity Provider Activates an inactive IdP
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • activateIdentityProvider

      public IdentityProvider activateIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
      Activate an Identity Provider Activates an inactive IdP
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • cloneIdentityProviderKey

      public JsonWebKey cloneIdentityProviderKey(String idpId, String idpKeyId, String targetIdpId) throws ApiException
      Clone a Signing Credential Key Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpKeyId - `id` of IdP Key (required)
      targetIdpId - (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • cloneIdentityProviderKey

      public JsonWebKey cloneIdentityProviderKey(String idpId, String idpKeyId, String targetIdpId, Map<String,String> additionalHeaders) throws ApiException
      Clone a Signing Credential Key Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpKeyId - `id` of IdP Key (required)
      targetIdpId - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • createIdentityProvider

      public IdentityProvider createIdentityProvider(IdentityProvider identityProvider) throws ApiException
      Create an Identity Provider Creates a new identity provider integration
      Parameters:
      identityProvider - (required)
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • createIdentityProvider

      public IdentityProvider createIdentityProvider(IdentityProvider identityProvider, Map<String,String> additionalHeaders) throws ApiException
      Create an Identity Provider Creates a new identity provider integration
      Parameters:
      identityProvider - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • createIdentityProviderKey

      public JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey) throws ApiException
      Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.
      Parameters:
      jsonWebKey - (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • createIdentityProviderKey

      public JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey, Map<String,String> additionalHeaders) throws ApiException
      Create an X.509 Certificate Public Key Creates a new X.509 certificate credential to the IdP key store.
      Parameters:
      jsonWebKey - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • deactivateIdentityProvider

      public IdentityProvider deactivateIdentityProvider(String idpId) throws ApiException
      Deactivate an Identity Provider Deactivates an active IdP
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • deactivateIdentityProvider

      public IdentityProvider deactivateIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
      Deactivate an Identity Provider Deactivates an active IdP
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • deleteIdentityProvider

      public void deleteIdentityProvider(String idpId) throws ApiException
      Delete an Identity Provider Deletes an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      Throws:
      ApiException - if fails to make API call

    • deleteIdentityProvider

      public void deleteIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
      Delete an Identity Provider Deletes an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteIdentityProviderKey

      public void deleteIdentityProviderKey(String idpKeyId) throws ApiException
      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
      Parameters:
      idpKeyId - `id` of IdP Key (required)
      Throws:
      ApiException - if fails to make API call

    • deleteIdentityProviderKey

      public void deleteIdentityProviderKey(String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
      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
      Parameters:
      idpKeyId - `id` of IdP Key (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • generateCsrForIdentityProvider

      public Csr generateCsrForIdentityProvider(String idpId, CsrMetadata metadata) throws ApiException
      Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request for it
      Parameters:
      idpId - `id` of IdP (required)
      metadata - (required)
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call

    • generateCsrForIdentityProvider

      public Csr generateCsrForIdentityProvider(String idpId, CsrMetadata metadata, Map<String,String> additionalHeaders) throws ApiException
      Generate a Certificate Signing Request Generates a new key pair and returns a Certificate Signing Request for it
      Parameters:
      idpId - `id` of IdP (required)
      metadata - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call

    • generateIdentityProviderSigningKey

      public JsonWebKey generateIdentityProviderSigningKey(String idpId, Integer validityYears) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      validityYears - expiry of the IdP Key Credential (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • generateIdentityProviderSigningKey

      public JsonWebKey generateIdentityProviderSigningKey(String idpId, Integer validityYears, Map<String,String> additionalHeaders) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      validityYears - expiry of the IdP Key Credential (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getCsrForIdentityProvider

      public Csr getCsrForIdentityProvider(String idpId, String idpCsrId) throws ApiException
      Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call

    • getCsrForIdentityProvider

      public Csr getCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Certificate Signing Request Retrieves a specific Certificate Signing Request model by id
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Csr
      Throws:
      ApiException - if fails to make API call

    • getIdentityProvider

      public IdentityProvider getIdentityProvider(String idpId) throws ApiException
      Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • getIdentityProvider

      public IdentityProvider getIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Identity Provider Retrieves an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderApplicationUser

      public IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId) throws ApiException
      Retrieve a User Retrieves a linked IdP user by ID
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderApplicationUser

      public IdentityProviderApplicationUser getIdentityProviderApplicationUser(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a User Retrieves a linked IdP user by ID
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderKey

      public JsonWebKey getIdentityProviderKey(String idpKeyId) throws ApiException
      Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      idpKeyId - `id` of IdP Key (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderKey

      public JsonWebKey getIdentityProviderKey(String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Credential Key Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      idpKeyId - `id` of IdP Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderSigningKey

      public JsonWebKey getIdentityProviderSigningKey(String idpId, String idpKeyId) throws ApiException
      Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      idpId - `id` of IdP (required)
      idpKeyId - `id` of IdP Key (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getIdentityProviderSigningKey

      public JsonWebKey getIdentityProviderSigningKey(String idpId, String idpKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Signing Credential Key Retrieves a specific IdP Key Credential by `kid`
      Parameters:
      idpId - `id` of IdP (required)
      idpKeyId - `id` of IdP Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • linkUserToIdentityProvider

      public IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      userIdentityProviderLinkRequest - (required)
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • linkUserToIdentityProvider

      public IdentityProviderApplicationUser linkUserToIdentityProvider(String idpId, String userId, UserIdentityProviderLinkRequest userIdentityProviderLinkRequest, Map<String,String> additionalHeaders) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      userIdentityProviderLinkRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProviderApplicationUser
      Throws:
      ApiException - if fails to make API call

    • listCsrsForIdentityProvider

      public List<Csr> listCsrsForIdentityProvider(String idpId) throws ApiException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      List<Csr>
      Throws:
      ApiException - if fails to make API call

    • listCsrsForIdentityProvider

      public List<Csr> listCsrsForIdentityProvider(String idpId, Map<String,String> additionalHeaders) throws ApiException
      List all Certificate Signing Requests Lists all Certificate Signing Requests for an IdP
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Csr>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderApplicationUsers

      public List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId) throws ApiException
      List all Users Lists all users linked to the identity provider
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      List<IdentityProviderApplicationUser>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderApplicationUsers

      public List<IdentityProviderApplicationUser> listIdentityProviderApplicationUsers(String idpId, Map<String,String> additionalHeaders) throws ApiException
      List all Users Lists all users linked to the identity provider
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdentityProviderApplicationUser>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderKeys

      public List<JsonWebKey> listIdentityProviderKeys(String after, Integer limit) throws ApiException
      List all Credential Keys Lists all IdP key credentials
      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:
      ApiException - if fails to make API call

    • listIdentityProviderKeys

      public List<JsonWebKey> listIdentityProviderKeys(String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Credential Keys Lists all IdP key credentials
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JsonWebKey>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderSigningKeys

      public List<JsonWebKey> listIdentityProviderSigningKeys(String idpId) throws ApiException
      List all Signing Credential Keys Lists all signing key credentials for an IdP
      Parameters:
      idpId - `id` of IdP (required)
      Returns:
      List<JsonWebKey>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviderSigningKeys

      public List<JsonWebKey> listIdentityProviderSigningKeys(String idpId, Map<String,String> additionalHeaders) throws ApiException
      List all Signing Credential Keys Lists all signing key credentials for an IdP
      Parameters:
      idpId - `id` of IdP (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<JsonWebKey>
      Throws:
      ApiException - if fails to make API call

    • listIdentityProviders

      public List<IdentityProvider> listIdentityProviders(String q, String after, Integer limit, String type) throws ApiException
      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.
      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:
      ApiException - if fails to make API call

    • listIdentityProviders

      public List<IdentityProvider> listIdentityProviders(String q, String after, Integer limit, String type, Map<String,String> additionalHeaders) throws ApiException
      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.
      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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdentityProvider>
      Throws:
      ApiException - if fails to make API call

    • listSocialAuthTokens

      public List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      Returns:
      List<SocialAuthToken>
      Throws:
      ApiException - if fails to make API call

    • listSocialAuthTokens

      public List<SocialAuthToken> listSocialAuthTokens(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      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
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<SocialAuthToken>
      Throws:
      ApiException - if fails to make API call

    • publishCsrForIdentityProvider

      public JsonWebKey publishCsrForIdentityProvider(String idpId, String idpCsrId, File body) throws ApiException
      Publish a Certificate Signing Request Publishes a certificate signing request with a signed X.509 certificate and adds it into the signing key credentials for the IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      body - (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • publishCsrForIdentityProvider

      public JsonWebKey publishCsrForIdentityProvider(String idpId, String idpCsrId, File body, Map<String,String> additionalHeaders) throws ApiException
      Publish a Certificate Signing Request Publishes a certificate signing request with a signed X.509 certificate and adds it into the signing key credentials for the IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • replaceIdentityProvider

      public IdentityProvider replaceIdentityProvider(String idpId, IdentityProvider identityProvider) throws ApiException
      Replace an Identity Provider Replaces an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      identityProvider - (required)
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • replaceIdentityProvider

      public IdentityProvider replaceIdentityProvider(String idpId, IdentityProvider identityProvider, Map<String,String> additionalHeaders) throws ApiException
      Replace an Identity Provider Replaces an identity provider integration by `idpId`
      Parameters:
      idpId - `id` of IdP (required)
      identityProvider - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentityProvider
      Throws:
      ApiException - if fails to make API call

    • revokeCsrForIdentityProvider

      public void revokeCsrForIdentityProvider(String idpId, String idpCsrId) throws ApiException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      Throws:
      ApiException - if fails to make API call

    • revokeCsrForIdentityProvider

      public void revokeCsrForIdentityProvider(String idpId, String idpCsrId, Map<String,String> additionalHeaders) throws ApiException
      Revoke a Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the IdP
      Parameters:
      idpId - `id` of IdP (required)
      idpCsrId - `id` of the IdP CSR (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • unlinkUserFromIdentityProvider

      public void unlinkUserFromIdentityProvider(String idpId, String userId) throws ApiException
      Unlink a User from IdP Unlinks the link between the Okta user and the IdP user
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      Throws:
      ApiException - if fails to make API call

    • unlinkUserFromIdentityProvider

      public void unlinkUserFromIdentityProvider(String idpId, String userId, Map<String,String> additionalHeaders) throws ApiException
      Unlink a User from IdP Unlinks the link between the Okta user and the IdP user
      Parameters:
      idpId - `id` of IdP (required)
      userId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()