Package com.okta.sdk.resource.identity.provider

Interface IdentityProvider

    • Method Detail

      • getLinks

        java.util.Map<java.lang.String,​java.lang.Object> getLinks()

      • getCreated

        java.util.Date getCreated()

      • getId

        java.lang.String getId()

      • getLastUpdated

        java.util.Date getLastUpdated()

      • getName

        java.lang.String getName()

      • getType

        java.lang.String getType()

      • getUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}")
IdentityProviderApplicationUser getUser​(java.lang.String userId)
        Fetches a linked IdP user by ID
        Parameters:
        userId - (required)
        Returns:
        IdentityProviderApplicationUser

      • getSigningCsr

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
Csr getSigningCsr​(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/idps/{idpId}/users/{userId}")
IdentityProviderApplicationUser linkUser​(java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}/credentials/tokens")
SocialAuthTokenList listSocialAuthTokens​(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
void deleteSigningCsr​(java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/idps/{idpId}/credentials/keys/{keyId}")
JsonWebKey getSigningKey​(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/generate")
JsonWebKey generateSigningKey​(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/idps/{idpId}/users/{userId}")
void unlinkUser​(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone")
JsonWebKey cloneKey​(java.lang.String keyId,
                    java.lang.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