Package com.okta.sdk.resource.application

Interface Application

    • Method Detail

      • getEmbedded

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

      • getLinks

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

      • getCreated

        java.util.Date getCreated()

      • getFeatures

        java.util.List<java.lang.String> getFeatures()

      • setFeatures

        Application setFeatures​(java.util.List<java.lang.String> features)

      • getId

        java.lang.String getId()

      • getLabel

        java.lang.String getLabel()

      • setLabel

        Application setLabel​(java.lang.String label)

      • getLastUpdated

        java.util.Date getLastUpdated()

      • getName

        java.lang.String getName()

      • getProfile

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

      • setProfile

        Application setProfile​(java.util.Map<java.lang.String,​java.lang.Object> profile)

      • getFeatureForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/features/{name}")
ApplicationFeature getFeatureForApplication​(java.lang.String name)
        Fetches a Feature object for an application. Fetches a Feature object for an application.
        Parameters:
        name - (required)
        Returns:
        ApplicationFeature

      • revokeCsr

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
void revokeCsr​(java.lang.String csrId)
        Parameters:
        csrId - (required)

      • getCsr

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
Csr getCsr​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        Csr

      • getApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/users/{userId}")
AppUser getApplicationUser​(java.lang.String userId,
                           java.lang.String expand)
        Get Assigned User for Application Fetches a specific user assignment for application by `id`.
        Parameters:
        userId - (required)
        expand - (optional)
        Returns:
        AppUser

      • getApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/users/{userId}")
AppUser getApplicationUser​(java.lang.String userId)
        Get Assigned User for Application Fetches a specific user assignment for application by `id`.
        Parameters:
        userId - (required)
        Returns:
        AppUser

      • cloneApplicationKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/{keyId}/clone")
JsonWebKey cloneApplicationKey​(java.lang.String keyId,
                               java.lang.String targetAid)
        Clone Application Key Credential Clones a X.509 certificate for an application key credential from a source application to target application.
        Parameters:
        keyId - (required)
        targetAid - Unique key of the target Application (required)
        Returns:
        JsonWebKey

      • generateCsr

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs")
Csr generateCsr​(CsrMetadata metadata)
        Generate Certificate Signing Request for Application Generates a new key pair and returns the Certificate Signing Request for it.
        Parameters:
        metadata - (required)
        Returns:
        Csr

      • listGroupAssignments

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listGroupAssignments​(java.lang.String q,
                                                    java.lang.String expand)
        List Groups Assigned to Application Enumerates group assignments for an application.
        Parameters:
        q - (optional)
        expand - (optional)
        Returns:
        ApplicationGroupAssignmentList

      • listGroupAssignments

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listGroupAssignments()
        List Groups Assigned to Application Enumerates group assignments for an application.
        Returns:
        ApplicationGroupAssignmentList

      • listScopeConsentGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants​(java.lang.String expand)
        Lists all scope consent grants for the application
        Parameters:
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrantList

      • listScopeConsentGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants()
        Lists all scope consent grants for the application
        Returns:
        OAuth2ScopeConsentGrantList

      • revokeOAuth2TokenForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/apps/{appId}/tokens/{tokenId}")
void revokeOAuth2TokenForApplication​(java.lang.String tokenId)
        Revokes the specified token for the specified application
        Parameters:
        tokenId - (required)

      • publishBinaryCerCert

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryCerCert​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        JsonWebKey

      • revokeOAuth2Tokens

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/apps/{appId}/tokens")
void revokeOAuth2Tokens()
        Revokes all tokens for the specified application

      • revokeScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/apps/{appId}/grants/{grantId}")
void revokeScopeConsentGrant​(java.lang.String grantId)
        Revokes permission for the application to request the given scope
        Parameters:
        grantId - (required)

      • assignUserToApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/users")
AppUser assignUserToApplication​(AppUser appUser)
        Assign User to Application for SSO & Provisioning Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.
        Parameters:
        appUser - (required)
        Returns:
        AppUser

      • grantConsentToScope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrant grantConsentToScope​(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant)
        Grants consent for the application to request an OAuth 2.0 Okta scope
        Parameters:
        oAuth2ScopeConsentGrant - (required)
        Returns:
        OAuth2ScopeConsentGrant

      • delete

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="DELETE - /api/v1/apps/{appId}")
void delete()
        Delete Application Removes an inactive application.
        Specified by:
        delete in interface Deletable

      • publishDerCert

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishDerCert​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        JsonWebKey

      • activate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/lifecycle/activate")
void activate()
        Activate Application Activates an inactive application.

      • createApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment createApplicationGroupAssignment​(java.lang.String groupId,
                                                            ApplicationGroupAssignment applicationGroupAssignment)
        Assign Group to Application Assigns a group to an application
        Parameters:
        groupId - (required)
        applicationGroupAssignment - (optional)
        Returns:
        ApplicationGroupAssignment

      • createApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment createApplicationGroupAssignment​(java.lang.String groupId)
        Assign Group to Application Assigns a group to an application
        Parameters:
        groupId - (required)
        Returns:
        ApplicationGroupAssignment

      • getApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment getApplicationGroupAssignment​(java.lang.String groupId,
                                                         java.lang.String expand)
        Get Assigned Group for Application Fetches an application group assignment
        Parameters:
        groupId - (required)
        expand - (optional)
        Returns:
        ApplicationGroupAssignment

      • getApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment getApplicationGroupAssignment​(java.lang.String groupId)
        Get Assigned Group for Application Fetches an application group assignment
        Parameters:
        groupId - (required)
        Returns:
        ApplicationGroupAssignment

      • generateKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateKey​(java.lang.Integer validityYears)
        Generates a new X.509 certificate for an application key credential
        Parameters:
        validityYears - (optional)
        Returns:
        JsonWebKey

      • generateKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateKey()
        Generates a new X.509 certificate for an application key credential
        Returns:
        JsonWebKey

      • listOAuth2Tokens

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2Tokens​(java.lang.String expand)
        Lists all tokens for the application
        Parameters:
        expand - (optional)
        Returns:
        OAuth2TokenList

      • listOAuth2Tokens

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2Tokens()
        Lists all tokens for the application
        Returns:
        OAuth2TokenList

      • getScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant​(java.lang.String grantId,
                                             java.lang.String expand)
        Fetches a single scope consent grant for the application
        Parameters:
        grantId - (required)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrant

      • getScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant​(java.lang.String grantId)
        Fetches a single scope consent grant for the application
        Parameters:
        grantId - (required)
        Returns:
        OAuth2ScopeConsentGrant

      • deactivate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/lifecycle/deactivate")
void deactivate()
        Deactivate Application Deactivates an active application.

      • publishBinaryPemCert

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryPemCert​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        JsonWebKey

      • update

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/apps/{appId}")
Application update()
        Update Application Updates an application in your organization.
        Returns:
        Application

      • listKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/credentials/keys")
JsonWebKeyList listKeys()
        List Key Credentials for Application Enumerates key credentials for an application
        Returns:
        JsonWebKeyList

      • getOAuth2Token

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2Token​(java.lang.String tokenId,
                           java.lang.String expand)
        Gets a token for the specified application
        Parameters:
        tokenId - (required)
        expand - (optional)
        Returns:
        OAuth2Token

      • getOAuth2Token

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2Token​(java.lang.String tokenId)
        Gets a token for the specified application
        Parameters:
        tokenId - (required)
        Returns:
        OAuth2Token

      • listCsrs

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs")
CsrList listCsrs()
        List Certificate Signing Requests for Application Enumerates Certificate Signing Requests for an application
        Returns:
        CsrList

      • listApplicationUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers​(java.lang.String q,
                                 java.lang.String queryScope,
                                 java.lang.String filter,
                                 java.lang.String expand)
        List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.
        Parameters:
        q - (optional)
        queryScope - (optional)
        filter - (optional)
        expand - (optional)
        Returns:
        AppUserList

      • listApplicationUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers()
        List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.
        Returns:
        AppUserList

      • getApplicationKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/apps/{appId}/credentials/keys/{keyId}")
JsonWebKey getApplicationKey​(java.lang.String keyId)
        Get Key Credential for Application Gets a specific application key credential by kid
        Parameters:
        keyId - (required)
        Returns:
        JsonWebKey

      • publishCerCert

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishCerCert​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        JsonWebKey

      • updateFeatureForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="PUT - /api/v1/apps/{appId}/features/{name}")
ApplicationFeature updateFeatureForApplication​(java.lang.String name,
                                               CapabilitiesObject capabilities)
        Updates a Feature object for an application. Updates a Feature object for an application.
        Parameters:
        name - (required)
        capabilities - (required)
        Returns:
        ApplicationFeature

      • publishBinaryDerCert

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishBinaryDerCert​(java.lang.String csrId)
        Parameters:
        csrId - (required)
        Returns:
        JsonWebKey

      • uploadApplicationLogo

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/apps/{appId}/logo")
void uploadApplicationLogo​(java.lang.String appId,
                           java.io.File file)
        The file must be in PNG, JPG, or GIF format, and less than 1 MB in size. For best results use landscape orientation, a transparent background, and a minimum size of 420px by 120px to prevent upscaling. Update the logo for an application.
        Parameters:
        appId - (required)
        file - (required)