Package com.okta.sdk.client

Interface Client

  • All Superinterfaces:
    DataStore
    @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]")
public interface Client
extends DataStore
    The Client is the main entry point to the Okta Java SDK. A JVM project wishing to communicate with the Okta REST API service must build a Client instance. After obtaining a Client instance, the REST API may be used by making simple Java calls on objects returned from the Client (or any children objects obtained therein).

    For example: 

     Client client = Clients.builder().build();

 client.getUser(userId)
    Since:
    0.5.0
    See Also:
    Communicating with Okta: Get your API Token, DataStore

    • Method Detail

      • getDataStore

        DataStore getDataStore()
        Returns the internal DataStore of the client. It is typically not necessary to invoke this method as the Client implements the DataStore API and will delegate to this instance automatically.
        Returns:
        the client's internal DataStore.

      • listApplications

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps")
ApplicationList listApplications​(java.lang.String q,
                                 java.lang.String filter,
                                 java.lang.String expand,
                                 java.lang.Boolean includeNonDeleted)
        List Applications Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.
        Parameters:
        q - (optional)
        filter - Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)
        expand - Traverses users link relationship and optionally embeds Application User resource (optional)
        includeNonDeleted - (optional, default to false)
        Returns:
        ApplicationList

      • listApplications

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps")
ApplicationList listApplications()
        List Applications Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.
        Returns:
        ApplicationList

      • createApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps")
Application createApplication​(Application application,
                              java.lang.Boolean activate,
                              java.lang.String oktaAccessGatewayAgent)
        Add Application Adds a new application to your Okta organization.
        Parameters:
        application - (required)
        activate - Executes activation lifecycle operation when creating the app (optional, default to true)
        oktaAccessGatewayAgent - (optional)
        Returns:
        Application

      • createApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps")
Application createApplication​(Application application)
        Add Application Adds a new application to your Okta organization.
        Parameters:
        application - (required)
        Returns:
        Application

      • deleteApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}")
void deleteApplication​(java.lang.String appId)
        Delete Application Removes an inactive application.
        Parameters:
        appId - (required)

      • getApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}")
Application getApplication​(java.lang.String appId,
                           java.lang.String expand)
        Get Application Fetches an application from your Okta organization by `id`.
        Parameters:
        appId - (required)
        expand - (optional)
        Returns:
        Application

      • getApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}")
Application getApplication​(java.lang.String appId)
        Get Application Fetches an application from your Okta organization by `id`.
        Parameters:
        appId - (required)
        Returns:
        Application

      • updateApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/apps/{appId}")
Application updateApplication​(Application application,
                              java.lang.String appId)
        Update Application Updates an application in your organization.
        Parameters:
        application - (required)
        appId - (required)
        Returns:
        Application

      • getDefaultProvisioningConnectionForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/connections/default")
ProvisioningConnection getDefaultProvisioningConnectionForApplication​(java.lang.String appId)
        Fetches the default Provisioning Connection for an application. Get default Provisioning Connection for application
        Parameters:
        appId - (required)
        Returns:
        ProvisioningConnection

      • setDefaultProvisioningConnectionForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/connections/default")
ProvisioningConnection setDefaultProvisioningConnectionForApplication​(ProvisioningConnectionRequest body,
                                                                      java.lang.String appId,
                                                                      java.lang.Boolean activate)
        Sets the default Provisioning Connection for an application. Set default Provisioning Connection for application
        Parameters:
        body - (required)
        appId - (required)
        activate - (optional)
        Returns:
        ProvisioningConnection

      • setDefaultProvisioningConnectionForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/connections/default")
ProvisioningConnection setDefaultProvisioningConnectionForApplication​(ProvisioningConnectionRequest body,
                                                                      java.lang.String appId)
        Sets the default Provisioning Connection for an application. Set default Provisioning Connection for application
        Parameters:
        body - (required)
        appId - (required)
        Returns:
        ProvisioningConnection

      • activateDefaultProvisioningConnectionForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/connections/default/lifecycle/activate")
void activateDefaultProvisioningConnectionForApplication​(java.lang.String appId)
        Activate default Provisioning Connection for application Activates the default Provisioning Connection for an application.
        Parameters:
        appId - (required)

      • deactivateDefaultProvisioningConnectionForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/connections/default/lifecycle/deactivate")
void deactivateDefaultProvisioningConnectionForApplication​(java.lang.String appId)
        Deactivate default Provisioning Connection for application Deactivates the default Provisioning Connection for an application.
        Parameters:
        appId - (required)

      • listCsrsForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs")
CsrList listCsrsForApplication​(java.lang.String appId)
        List Certificate Signing Requests for Application Enumerates Certificate Signing Requests for an application
        Parameters:
        appId - (required)
        Returns:
        CsrList

      • generateCsrForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs")
Csr generateCsrForApplication​(CsrMetadata metadata,
                              java.lang.String appId)
        Generate Certificate Signing Request for Application Generates a new key pair and returns the Certificate Signing Request for it.
        Parameters:
        metadata - (required)
        appId - (required)
        Returns:
        Csr

      • revokeCsrFromApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
void revokeCsrFromApplication​(java.lang.String appId,
                              java.lang.String csrId)
        Revoke Certificate Signing Request Revokes a certificate signing request and deletes the key pair from the application.
        Parameters:
        appId - (required)
        csrId - (required)

      • getCsrForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/credentials/csrs/{csrId}")
Csr getCsrForApplication​(java.lang.String appId,
                         java.lang.String csrId)
        Get Certificate Signing Request Fetches a certificate signing request for the app by `id`.
        Parameters:
        appId - (required)
        csrId - (required)
        Returns:
        Csr

      • publishCsrFromApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishCsrFromApplication​(java.io.InputStream body,
                                     java.lang.String appId,
                                     java.lang.String csrId)
        Publish Certificate Signing Request Updates a certificate signing request for the app with a signed X.509 certificate and adds it into the application key credentials
        Parameters:
        body - (required)
        appId - (required)
        csrId - (required)
        Returns:
        JsonWebKey

      • listApplicationKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/credentials/keys")
JsonWebKeyList listApplicationKeys​(java.lang.String appId)
        List Key Credentials for Application Enumerates key credentials for an application
        Parameters:
        appId - (required)
        Returns:
        JsonWebKeyList

      • generateApplicationKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateApplicationKey​(java.lang.String appId,
                                  java.lang.Integer validityYears)
        Generate Key Credential for Application Generates a new X.509 certificate for an application key credential
        Parameters:
        appId - (required)
        validityYears - (optional)
        Returns:
        JsonWebKey

      • generateApplicationKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/generate")
JsonWebKey generateApplicationKey​(java.lang.String appId)
        Generate Key Credential for Application Generates a new X.509 certificate for an application key credential
        Parameters:
        appId - (required)
        Returns:
        JsonWebKey

      • getApplicationKey

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

      • cloneApplicationKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/credentials/keys/{keyId}/clone")
JsonWebKey cloneApplicationKey​(java.lang.String appId,
                               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:
        appId - (required)
        keyId - (required)
        targetAid - Unique key of the target Application (required)
        Returns:
        JsonWebKey

      • listFeaturesForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/features")
ApplicationFeatureList listFeaturesForApplication​(java.lang.String appId)
        Fetches the Feature objects for an application. List Features for application
        Parameters:
        appId - (required)
        Returns:
        ApplicationFeatureList

      • getFeatureForApplication

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

      • updateFeatureForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/apps/{appId}/features/{name}")
ApplicationFeature updateFeatureForApplication​(CapabilitiesObject body,
                                               java.lang.String appId,
                                               java.lang.String name)
        Updates a Feature object for an application. Updates a Feature object for an application.
        Parameters:
        body - (required)
        appId - (required)
        name - (required)
        Returns:
        ApplicationFeature

      • listScopeConsentGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants​(java.lang.String appId,
                                                   java.lang.String expand)
        List Scope Consent Grants for Application Lists all scope consent grants for the application
        Parameters:
        appId - (required)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrantList

      • listScopeConsentGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrantList listScopeConsentGrants​(java.lang.String appId)
        List Scope Consent Grants for Application Lists all scope consent grants for the application
        Parameters:
        appId - (required)
        Returns:
        OAuth2ScopeConsentGrantList

      • grantConsentToScope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/grants")
OAuth2ScopeConsentGrant grantConsentToScope​(OAuth2ScopeConsentGrant oAuth2ScopeConsentGrant,
                                            java.lang.String appId)
        Grant Consent to Scope for Application Grants consent for the application to request an OAuth 2.0 Okta scope
        Parameters:
        oAuth2ScopeConsentGrant - (required)
        appId - (required)
        Returns:
        OAuth2ScopeConsentGrant

      • revokeScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/grants/{grantId}")
void revokeScopeConsentGrant​(java.lang.String appId,
                             java.lang.String grantId)
        Revoke Scope Consent Grant for Application Revokes permission for the application to request the given scope
        Parameters:
        appId - (required)
        grantId - (required)

      • getScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant​(java.lang.String appId,
                                             java.lang.String grantId,
                                             java.lang.String expand)
        Get Scope Consent Grant for Application Fetches a single scope consent grant for the application
        Parameters:
        appId - (required)
        grantId - (required)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrant

      • getScopeConsentGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/grants/{grantId}")
OAuth2ScopeConsentGrant getScopeConsentGrant​(java.lang.String appId,
                                             java.lang.String grantId)
        Get Scope Consent Grant for Application Fetches a single scope consent grant for the application
        Parameters:
        appId - (required)
        grantId - (required)
        Returns:
        OAuth2ScopeConsentGrant

      • listApplicationGroupAssignments

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listApplicationGroupAssignments​(java.lang.String appId,
                                                               java.lang.String q,
                                                               java.lang.String expand)
        List Groups Assigned to Application Enumerates group assignments for an application.
        Parameters:
        appId - (required)
        q - (optional)
        expand - (optional)
        Returns:
        ApplicationGroupAssignmentList

      • listApplicationGroupAssignments

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/groups")
ApplicationGroupAssignmentList listApplicationGroupAssignments​(java.lang.String appId)
        List Groups Assigned to Application Enumerates group assignments for an application.
        Parameters:
        appId - (required)
        Returns:
        ApplicationGroupAssignmentList

      • deleteApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/groups/{groupId}")
void deleteApplicationGroupAssignment​(java.lang.String appId,
                                      java.lang.String groupId)
        Remove Group from Application Removes a group assignment from an application.
        Parameters:
        appId - (required)
        groupId - (required)

      • getApplicationGroupAssignment

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

      • getApplicationGroupAssignment

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

      • createApplicationGroupAssignment

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/apps/{appId}/groups/{groupId}")
ApplicationGroupAssignment createApplicationGroupAssignment​(ApplicationGroupAssignment applicationGroupAssignment,
                                                            java.lang.String appId,
                                                            java.lang.String groupId)
        Assign Group to Application Assigns a group to an application
        Parameters:
        applicationGroupAssignment - (required)
        appId - (required)
        groupId - (required)
        Returns:
        ApplicationGroupAssignment

      • activateApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/lifecycle/activate")
void activateApplication​(java.lang.String appId)
        Activate Application Activates an inactive application.
        Parameters:
        appId - (required)

      • deactivateApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/lifecycle/deactivate")
void deactivateApplication​(java.lang.String appId)
        Deactivate Application Deactivates an active application.
        Parameters:
        appId - (required)

      • revokeOAuth2TokensForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/tokens")
void revokeOAuth2TokensForApplication​(java.lang.String appId)
        Revoke All OAuth 2.0 Tokens for Application Revokes all tokens for the specified application
        Parameters:
        appId - (required)

      • listOAuth2TokensForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2TokensForApplication​(java.lang.String appId,
                                               java.lang.String expand)
        Lists OAuth 2.0 Tokens for Application Lists all tokens for the application
        Parameters:
        appId - (required)
        expand - (optional)
        Returns:
        OAuth2TokenList

      • listOAuth2TokensForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/tokens")
OAuth2TokenList listOAuth2TokensForApplication​(java.lang.String appId)
        Lists OAuth 2.0 Tokens for Application Lists all tokens for the application
        Parameters:
        appId - (required)
        Returns:
        OAuth2TokenList

      • revokeOAuth2TokenForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/tokens/{tokenId}")
void revokeOAuth2TokenForApplication​(java.lang.String appId,
                                     java.lang.String tokenId)
        Revoke an OAuth 2.0 Token for Application Revokes the specified token for the specified application
        Parameters:
        appId - (required)
        tokenId - (required)

      • getOAuth2TokenForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2TokenForApplication​(java.lang.String appId,
                                         java.lang.String tokenId,
                                         java.lang.String expand)
        Get OAuth 2.0 Token for Application Gets a token for the specified application
        Parameters:
        appId - (required)
        tokenId - (required)
        expand - (optional)
        Returns:
        OAuth2Token

      • getOAuth2TokenForApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/tokens/{tokenId}")
OAuth2Token getOAuth2TokenForApplication​(java.lang.String appId,
                                         java.lang.String tokenId)
        Get OAuth 2.0 Token for Application Gets a token for the specified application
        Parameters:
        appId - (required)
        tokenId - (required)
        Returns:
        OAuth2Token

      • listApplicationUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers​(java.lang.String appId,
                                 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:
        appId - (required)
        q - (optional)
        queryScope - (optional)
        filter - (optional)
        expand - (optional)
        Returns:
        AppUserList

      • listApplicationUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/apps/{appId}/users")
AppUserList listApplicationUsers​(java.lang.String appId)
        List Users Assigned to Application Enumerates all assigned [application users](#application-user-model) for an application.
        Parameters:
        appId - (required)
        Returns:
        AppUserList

      • assignUserToApplication

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/users")
AppUser assignUserToApplication​(AppUser appUser,
                                java.lang.String appId)
        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)
        appId - (required)
        Returns:
        AppUser

      • deleteApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/users/{userId}")
void deleteApplicationUser​(java.lang.String appId,
                           java.lang.String userId,
                           java.lang.Boolean sendEmail)
        Remove User from Application Removes an assignment for a user from an application.
        Parameters:
        appId - (required)
        userId - (required)
        sendEmail - (optional, default to false)

      • deleteApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/apps/{appId}/users/{userId}")
void deleteApplicationUser​(java.lang.String appId,
                           java.lang.String userId)
        Remove User from Application Removes an assignment for a user from an application.
        Parameters:
        appId - (required)
        userId - (required)

      • getApplicationUser

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

      • getApplicationUser

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

      • updateApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/apps/{appId}/users/{userId}")
AppUser updateApplicationUser​(AppUser appUser,
                              java.lang.String appId,
                              java.lang.String userId)
        Update Application Profile for Assigned User Updates a user's profile for an application
        Parameters:
        appUser - (required)
        appId - (required)
        userId - (required)
        Returns:
        AppUser

      • listAuthenticators

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authenticators")
AuthenticatorList listAuthenticators()
        List Authenticators Enumerates authenticators in your organization.
        Returns:
        AuthenticatorList

      • getAuthenticator

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authenticators/{authenticatorId}")
Authenticator getAuthenticator​(java.lang.String authenticatorId)
        Get Authenticator Fetches an authenticator from your Okta organization by `authenticatorId`.
        Parameters:
        authenticatorId - (required)
        Returns:
        Authenticator

      • updateAuthenticator

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authenticators/{authenticatorId}")
Authenticator updateAuthenticator​(Authenticator authenticator,
                                  java.lang.String authenticatorId)
        Update Authenticator Updates an authenticator
        Parameters:
        authenticator - (required)
        authenticatorId - (required)
        Returns:
        Authenticator

      • activateAuthenticator

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authenticators/{authenticatorId}/lifecycle/activate")
Authenticator activateAuthenticator​(java.lang.String authenticatorId)
        Activate Authenticator Activates an authenticator by `authenticatorId`.
        Parameters:
        authenticatorId - (required)
        Returns:
        Authenticator

      • deactivateAuthenticator

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate")
Authenticator deactivateAuthenticator​(java.lang.String authenticatorId)
        Deactivate Authenticator Deactivates an authenticator by `authenticatorId`.
        Parameters:
        authenticatorId - (required)
        Returns:
        Authenticator

      • listAuthorizationServers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers")
AuthorizationServerList listAuthorizationServers​(java.lang.String q)
        List Authorization Servers Success
        Parameters:
        q - (optional)
        Returns:
        AuthorizationServerList

      • listAuthorizationServers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers")
AuthorizationServerList listAuthorizationServers()
        List Authorization Servers Success
        Returns:
        AuthorizationServerList

      • createAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers")
AuthorizationServer createAuthorizationServer​(AuthorizationServer authorizationServer)
        Create Authorization Server Success
        Parameters:
        authorizationServer - (required)
        Returns:
        AuthorizationServer

      • deleteAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}")
void deleteAuthorizationServer​(java.lang.String authServerId)
        Delete Authorization Server Success
        Parameters:
        authServerId - (required)

      • getAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}")
AuthorizationServer getAuthorizationServer​(java.lang.String authServerId)
        Get Authorization Server Success
        Parameters:
        authServerId - (required)
        Returns:
        AuthorizationServer

      • updateAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authorizationServers/{authServerId}")
AuthorizationServer updateAuthorizationServer​(AuthorizationServer authorizationServer,
                                              java.lang.String authServerId)
        Update Authorization Server Success
        Parameters:
        authorizationServer - (required)
        authServerId - (required)
        Returns:
        AuthorizationServer

      • listOAuth2Claims

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/claims")
OAuth2ClaimList listOAuth2Claims​(java.lang.String authServerId)
        List Custom OAuth 2.0 Token Claims Success
        Parameters:
        authServerId - (required)
        Returns:
        OAuth2ClaimList

      • createOAuth2Claim

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/claims")
OAuth2Claim createOAuth2Claim​(OAuth2Claim oAuth2Claim,
                              java.lang.String authServerId)
        Create Custom OAuth 2.0 Token Claim Success
        Parameters:
        oAuth2Claim - (required)
        authServerId - (required)
        Returns:
        OAuth2Claim

      • deleteOAuth2Claim

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
void deleteOAuth2Claim​(java.lang.String authServerId,
                       java.lang.String claimId)
        Delete Custom OAuth 2.0 Token Claim Success
        Parameters:
        authServerId - (required)
        claimId - (required)

      • getOAuth2Claim

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
OAuth2Claim getOAuth2Claim​(java.lang.String authServerId,
                           java.lang.String claimId)
        Get Oauth2claim Success
        Parameters:
        authServerId - (required)
        claimId - (required)
        Returns:
        OAuth2Claim

      • updateOAuth2Claim

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/claims/{claimId}")
OAuth2Claim updateOAuth2Claim​(OAuth2Claim oAuth2Claim,
                              java.lang.String authServerId,
                              java.lang.String claimId)
        Update Custom OAuth 2.0 Token Claim Success
        Parameters:
        oAuth2Claim - (required)
        authServerId - (required)
        claimId - (required)
        Returns:
        OAuth2Claim

      • listOAuth2ClientsForAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients")
OAuth2ClientList listOAuth2ClientsForAuthorizationServer​(java.lang.String authServerId)
        List Oauth2clients for Authorization Server Success
        Parameters:
        authServerId - (required)
        Returns:
        OAuth2ClientList

      • revokeRefreshTokensForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
void revokeRefreshTokensForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                        java.lang.String clientId)
        Revoke Refresh Tokens for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)

      • listRefreshTokensForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                                        java.lang.String clientId,
                                                                        java.lang.String expand)
        List Refresh Tokens for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshTokenList

      • listRefreshTokensForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                                        java.lang.String clientId)
        List Refresh Tokens for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)
        Returns:
        OAuth2RefreshTokenList

      • revokeRefreshTokenForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
void revokeRefreshTokenForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                       java.lang.String clientId,
                                                       java.lang.String tokenId)
        Revoke Refresh Token for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)
        tokenId - (required)

      • getRefreshTokenForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                                  java.lang.String clientId,
                                                                  java.lang.String tokenId,
                                                                  java.lang.String expand)
        Get Refresh Token for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)
        tokenId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshToken

      • getRefreshTokenForAuthorizationServerAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForAuthorizationServerAndClient​(java.lang.String authServerId,
                                                                  java.lang.String clientId,
                                                                  java.lang.String tokenId)
        Get Refresh Token for Authorization Server and Client Success
        Parameters:
        authServerId - (required)
        clientId - (required)
        tokenId - (required)
        Returns:
        OAuth2RefreshToken

      • listAuthorizationServerKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/credentials/keys")
JsonWebKeyList listAuthorizationServerKeys​(java.lang.String authServerId)
        List Authorization Server Keys Success
        Parameters:
        authServerId - (required)
        Returns:
        JsonWebKeyList

      • rotateAuthorizationServerKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate")
JsonWebKeyList rotateAuthorizationServerKeys​(JwkUse use,
                                             java.lang.String authServerId)
        Rotate Authorization Server Keys Success
        Parameters:
        use - (required)
        authServerId - (required)
        Returns:
        JsonWebKeyList

      • activateAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/lifecycle/activate")
void activateAuthorizationServer​(java.lang.String authServerId)
        Activate Authorization Server Success
        Parameters:
        authServerId - (required)

      • deactivateAuthorizationServer

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate")
void deactivateAuthorizationServer​(java.lang.String authServerId)
        Deactivate Authorization Server Success
        Parameters:
        authServerId - (required)

      • listAuthorizationServerPolicies

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies")
AuthorizationServerPolicyList listAuthorizationServerPolicies​(java.lang.String authServerId)
        List Authorization Server Policies Success
        Parameters:
        authServerId - (required)
        Returns:
        AuthorizationServerPolicyList

      • createAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies")
AuthorizationServerPolicy createAuthorizationServerPolicy​(AuthorizationServerPolicy policy,
                                                          java.lang.String authServerId)
        Create Authorization Server Policy Success
        Parameters:
        policy - (required)
        authServerId - (required)
        Returns:
        AuthorizationServerPolicy

      • deleteAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
void deleteAuthorizationServerPolicy​(java.lang.String authServerId,
                                     java.lang.String policyId)
        Delete Authorization Server Policy Success
        Parameters:
        authServerId - (required)
        policyId - (required)

      • getAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
AuthorizationServerPolicy getAuthorizationServerPolicy​(java.lang.String authServerId,
                                                       java.lang.String policyId)
        Get Authorization Server Policy Success
        Parameters:
        authServerId - (required)
        policyId - (required)
        Returns:
        AuthorizationServerPolicy

      • updateAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/policies/{policyId}")
AuthorizationServerPolicy updateAuthorizationServerPolicy​(AuthorizationServerPolicy policy,
                                                          java.lang.String authServerId,
                                                          java.lang.String policyId)
        Update Authorization Server Policy Success
        Parameters:
        policy - (required)
        authServerId - (required)
        policyId - (required)
        Returns:
        AuthorizationServerPolicy

      • activateAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate")
void activateAuthorizationServerPolicy​(java.lang.String authServerId,
                                       java.lang.String policyId)
        Activate Authorization Server Policy Activate Authorization Server Policy
        Parameters:
        authServerId - (required)
        policyId - (required)

      • deactivateAuthorizationServerPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate")
void deactivateAuthorizationServerPolicy​(java.lang.String authServerId,
                                         java.lang.String policyId)
        Deactivate Authorization Server Policy Deactivate Authorization Server Policy
        Parameters:
        authServerId - (required)
        policyId - (required)

      • listAuthorizationServerPolicyRules

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
AuthorizationServerPolicyRuleList listAuthorizationServerPolicyRules​(java.lang.String policyId,
                                                                     java.lang.String authServerId)
        List Authorization Server Policy Rules Enumerates all policy rules for the specified Custom Authorization Server and Policy.
        Parameters:
        policyId - (required)
        authServerId - (required)
        Returns:
        AuthorizationServerPolicyRuleList

      • createAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules")
AuthorizationServerPolicyRule createAuthorizationServerPolicyRule​(AuthorizationServerPolicyRule policyRule,
                                                                  java.lang.String policyId,
                                                                  java.lang.String authServerId)
        Create Authorization Server Policy Rule Creates a policy rule for the specified Custom Authorization Server and Policy.
        Parameters:
        policyRule - (required)
        policyId - (required)
        authServerId - (required)
        Returns:
        AuthorizationServerPolicyRule

      • deleteAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
void deleteAuthorizationServerPolicyRule​(java.lang.String policyId,
                                         java.lang.String authServerId,
                                         java.lang.String ruleId)
        Delete Authorization Server Policy Rule Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.
        Parameters:
        policyId - (required)
        authServerId - (required)
        ruleId - (required)

      • getAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
AuthorizationServerPolicyRule getAuthorizationServerPolicyRule​(java.lang.String policyId,
                                                               java.lang.String authServerId,
                                                               java.lang.String ruleId)
        Get Authorization Server Policy Rule Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.
        Parameters:
        policyId - (required)
        authServerId - (required)
        ruleId - (required)
        Returns:
        AuthorizationServerPolicyRule

      • updateAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}")
AuthorizationServerPolicyRule updateAuthorizationServerPolicyRule​(AuthorizationServerPolicyRule policyRule,
                                                                  java.lang.String policyId,
                                                                  java.lang.String authServerId,
                                                                  java.lang.String ruleId)
        Update Authorization Server Policy Rule Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.
        Parameters:
        policyRule - (required)
        policyId - (required)
        authServerId - (required)
        ruleId - (required)
        Returns:
        AuthorizationServerPolicyRule

      • activateAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate")
void activateAuthorizationServerPolicyRule​(java.lang.String authServerId,
                                           java.lang.String policyId,
                                           java.lang.String ruleId)
        Activate Authorization Server Policy Rule Activate Authorization Server Policy Rule
        Parameters:
        authServerId - (required)
        policyId - (required)
        ruleId - (required)

      • deactivateAuthorizationServerPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate")
void deactivateAuthorizationServerPolicyRule​(java.lang.String authServerId,
                                             java.lang.String policyId,
                                             java.lang.String ruleId)
        Deactivate Authorization Server Policy Rule Deactivate Authorization Server Policy Rule
        Parameters:
        authServerId - (required)
        policyId - (required)
        ruleId - (required)

      • listOAuth2Scopes

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes")
OAuth2ScopeList listOAuth2Scopes​(java.lang.String authServerId,
                                 java.lang.String q,
                                 java.lang.String filter,
                                 java.lang.String cursor)
        List Oauth2scopes Success
        Parameters:
        authServerId - (required)
        q - (optional)
        filter - (optional)
        cursor - (optional)
        Returns:
        OAuth2ScopeList

      • listOAuth2Scopes

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes")
OAuth2ScopeList listOAuth2Scopes​(java.lang.String authServerId)
        List Oauth2scopes Success
        Parameters:
        authServerId - (required)
        Returns:
        OAuth2ScopeList

      • createOAuth2Scope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/authorizationServers/{authServerId}/scopes")
OAuth2Scope createOAuth2Scope​(OAuth2Scope oAuth2Scope,
                              java.lang.String authServerId)
        Create Oauth2scope Success
        Parameters:
        oAuth2Scope - (required)
        authServerId - (required)
        Returns:
        OAuth2Scope

      • deleteOAuth2Scope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
void deleteOAuth2Scope​(java.lang.String authServerId,
                       java.lang.String scopeId)
        Delete Oauth2scope Success
        Parameters:
        authServerId - (required)
        scopeId - (required)

      • getOAuth2Scope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
OAuth2Scope getOAuth2Scope​(java.lang.String authServerId,
                           java.lang.String scopeId)
        Get Oauth2scope Success
        Parameters:
        authServerId - (required)
        scopeId - (required)
        Returns:
        OAuth2Scope

      • updateOAuth2Scope

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}")
OAuth2Scope updateOAuth2Scope​(OAuth2Scope oAuth2Scope,
                              java.lang.String authServerId,
                              java.lang.String scopeId)
        Update Oauth2scope Success
        Parameters:
        oAuth2Scope - (required)
        authServerId - (required)
        scopeId - (required)
        Returns:
        OAuth2Scope

      • listBrands

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/brands")
BrandList listBrands()
        List Brands List all the brands in your org.
        Returns:
        BrandList

      • getBrand

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/brands/{brandId}")
Brand getBrand​(java.lang.String brandId)
        Get Brand Fetches a brand by `brandId`
        Parameters:
        brandId - (required)
        Returns:
        Brand

      • updateBrand

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/brands/{brandId}")
Brand updateBrand​(Brand brand,
                  java.lang.String brandId)
        Update Brand Updates a brand by `brandId`
        Parameters:
        brand - (required)
        brandId - (required)
        Returns:
        Brand

      • listBrandThemes

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/brands/{brandId}/themes")
ThemeResponseList listBrandThemes​(java.lang.String brandId)
        Get Brand Themes List all the themes in your brand
        Parameters:
        brandId - (required)
        Returns:
        ThemeResponseList

      • getBrandTheme

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/brands/{brandId}/themes/{themeId}")
ThemeResponse getBrandTheme​(java.lang.String brandId,
                            java.lang.String themeId)
        Get a theme for a brand Fetches a theme for a brand
        Parameters:
        brandId - (required)
        themeId - (required)
        Returns:
        ThemeResponse

      • updateBrandTheme

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/brands/{brandId}/themes/{themeId}")
ThemeResponse updateBrandTheme​(Theme theme,
                               java.lang.String brandId,
                               java.lang.String themeId)
        Update a theme for a brand Updates a theme for a brand
        Parameters:
        theme - (required)
        brandId - (required)
        themeId - (required)
        Returns:
        ThemeResponse

      • deleteBrandThemeBackgroundImage

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
void deleteBrandThemeBackgroundImage​(java.lang.String brandId,
                                     java.lang.String themeId)
        Deletes a Theme background image Deletes a Theme background image
        Parameters:
        brandId - (required)
        themeId - (required)

      • uploadBrandThemeBackgroundImage

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
ImageUploadResponse uploadBrandThemeBackgroundImage​(java.lang.String brandId,
                                                    java.lang.String themeId)
        Updates the background image for your Theme Updates the background image for your Theme
        Parameters:
        brandId - (required)
        themeId - (required)
        Returns:
        ImageUploadResponse

      • deleteBrandThemeFavicon

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
void deleteBrandThemeFavicon​(java.lang.String brandId,
                             java.lang.String themeId)
        Deletes a Theme favicon. The org then uses the Okta default favicon. Deletes a Theme favicon. The org then uses the Okta default favicon.
        Parameters:
        brandId - (required)
        themeId - (required)

      • uploadBrandThemeFavicon

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
ImageUploadResponse uploadBrandThemeFavicon​(java.lang.String brandId,
                                            java.lang.String themeId)
        Updates the favicon for your theme Updates the favicon for your theme
        Parameters:
        brandId - (required)
        themeId - (required)
        Returns:
        ImageUploadResponse

      • deleteBrandThemeLogo

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/logo")
void deleteBrandThemeLogo​(java.lang.String brandId,
                          java.lang.String themeId)
        Deletes a Theme logo. The org then uses the Okta default logo. Deletes a Theme logo. The org then uses the Okta default logo.
        Parameters:
        brandId - (required)
        themeId - (required)

      • uploadBrandThemeLogo

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/logo")
ImageUploadResponse uploadBrandThemeLogo​(java.lang.String brandId,
                                         java.lang.String themeId)
        Update a themes logo Updates the logo for your Theme
        Parameters:
        brandId - (required)
        themeId - (required)
        Returns:
        ImageUploadResponse

      • listCaptchaInstances

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/captchas")
CAPTCHAInstanceList listCaptchaInstances()
        List CAPTCHA instances Enumerates CAPTCHA instances in your organization with pagination. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.
        Returns:
        CAPTCHAInstanceList

      • createCaptchaInstance

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/captchas")
CAPTCHAInstance createCaptchaInstance​(CAPTCHAInstance instance)
        Create new CAPTCHA instance Adds a new CAPTCHA instance to your organization. In the current release, we only allow one CAPTCHA instance per org.
        Parameters:
        instance - (required)
        Returns:
        CAPTCHAInstance

      • deleteCaptchaInstance

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/captchas/{captchaId}")
void deleteCaptchaInstance​(java.lang.String captchaId)
        Delete CAPTCHA Instance Delete a CAPTCHA instance by `id`. If the CAPTCHA instance is currently being used in the org, the delete will not be allowed.
        Parameters:
        captchaId - id of the CAPTCHA (required)

      • getCaptchaInstance

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/captchas/{captchaId}")
CAPTCHAInstance getCaptchaInstance​(java.lang.String captchaId)
        Get CAPTCHA Instance Fetches a CAPTCHA instance by `id`.
        Parameters:
        captchaId - id of the CAPTCHA (required)
        Returns:
        CAPTCHAInstance

      • partialUpdateCaptchaInstance

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/captchas/{captchaId}")
CAPTCHAInstance partialUpdateCaptchaInstance​(CAPTCHAInstance instance,
                                             java.lang.String captchaId)
        Partial Update CAPTCHA instance Partially update a CAPTCHA instance by `id`.
        Parameters:
        instance - (required)
        captchaId - id of the CAPTCHA (required)
        Returns:
        CAPTCHAInstance

      • updateCaptchaInstance

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/captchas/{captchaId}")
CAPTCHAInstance updateCaptchaInstance​(CAPTCHAInstance instance,
                                      java.lang.String captchaId)
        Update CAPTCHA instance Update a CAPTCHA instance by `id`.
        Parameters:
        instance - (required)
        captchaId - id of the CAPTCHA (required)
        Returns:
        CAPTCHAInstance

      • listDomains

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/domains")
DomainListResponse listDomains()
        List Domains List all verified custom Domains for the org.
        Returns:
        DomainListResponse

      • createDomain

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/domains")
DomainResponse createDomain​(Domain domain)
        Create Domain Creates your domain.
        Parameters:
        domain - (required)
        Returns:
        DomainResponse

      • deleteDomain

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/domains/{domainId}")
void deleteDomain​(java.lang.String domainId)
        Delete Domain Deletes a Domain by `id`.
        Parameters:
        domainId - (required)

      • getDomain

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/domains/{domainId}")
DomainResponse getDomain​(java.lang.String domainId)
        Get Domain Fetches a Domain by `id`.
        Parameters:
        domainId - (required)
        Returns:
        DomainResponse

      • createCertificate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/domains/{domainId}/certificate")
void createCertificate​(DomainCertificate certificate,
                       java.lang.String domainId)
        Create Certificate Creates the Certificate for the Domain.
        Parameters:
        certificate - (required)
        domainId - (required)

      • verifyDomain

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/domains/{domainId}/verify")
DomainResponse verifyDomain​(java.lang.String domainId)
        Verify Domain Verifies the Domain by `id`.
        Parameters:
        domainId - (required)
        Returns:
        DomainResponse

      • listEventHooks

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/eventHooks")
EventHookList listEventHooks()
        List Event Hooks Success
        Returns:
        EventHookList

      • createEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/eventHooks")
EventHook createEventHook​(EventHook eventHook)
        Create Event Hook Success
        Parameters:
        eventHook - (required)
        Returns:
        EventHook

      • deleteEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/eventHooks/{eventHookId}")
void deleteEventHook​(java.lang.String eventHookId)
        Delete Event Hook Success
        Parameters:
        eventHookId - (required)

      • getEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/eventHooks/{eventHookId}")
EventHook getEventHook​(java.lang.String eventHookId)
        Get Event Hook Success
        Parameters:
        eventHookId - (required)
        Returns:
        EventHook

      • updateEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/eventHooks/{eventHookId}")
EventHook updateEventHook​(EventHook eventHook,
                          java.lang.String eventHookId)
        Update Event Hook Success
        Parameters:
        eventHook - (required)
        eventHookId - (required)
        Returns:
        EventHook

      • activateEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/eventHooks/{eventHookId}/lifecycle/activate")
EventHook activateEventHook​(java.lang.String eventHookId)
        Activate Event Hook Success
        Parameters:
        eventHookId - (required)
        Returns:
        EventHook

      • deactivateEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/eventHooks/{eventHookId}/lifecycle/deactivate")
EventHook deactivateEventHook​(java.lang.String eventHookId)
        Deactivate Event Hook Success
        Parameters:
        eventHookId - (required)
        Returns:
        EventHook

      • verifyEventHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/eventHooks/{eventHookId}/lifecycle/verify")
EventHook verifyEventHook​(java.lang.String eventHookId)
        Verify Event Hook Success
        Parameters:
        eventHookId - (required)
        Returns:
        EventHook

      • listFeatures

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/features")
FeatureList listFeatures()
        List Features Success
        Returns:
        FeatureList

      • getFeature

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/features/{featureId}")
Feature getFeature​(java.lang.String featureId)
        Get Feature Success
        Parameters:
        featureId - (required)
        Returns:
        Feature

      • listFeatureDependencies

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/features/{featureId}/dependencies")
FeatureList listFeatureDependencies​(java.lang.String featureId)
        List Feature Dependencies Success
        Parameters:
        featureId - (required)
        Returns:
        FeatureList

      • listFeatureDependents

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/features/{featureId}/dependents")
FeatureList listFeatureDependents​(java.lang.String featureId)
        List Feature Dependents Success
        Parameters:
        featureId - (required)
        Returns:
        FeatureList

      • updateFeatureLifecycle

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/features/{featureId}/{lifecycle}")
Feature updateFeatureLifecycle​(java.lang.String featureId,
                               java.lang.String lifecycle,
                               java.lang.String mode)
        Update Feature Lifecycle Success
        Parameters:
        featureId - (required)
        lifecycle - (required)
        mode - (optional)
        Returns:
        Feature

      • updateFeatureLifecycle

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/features/{featureId}/{lifecycle}")
Feature updateFeatureLifecycle​(java.lang.String featureId,
                               java.lang.String lifecycle)
        Update Feature Lifecycle Success
        Parameters:
        featureId - (required)
        lifecycle - (required)
        Returns:
        Feature

      • listGroups

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups")
GroupList listGroups​(java.lang.String q,
                     java.lang.String search,
                     java.lang.String expand)
        List Groups Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.
        Parameters:
        q - Searches the name property of groups for matching value (optional)
        search - Filter expression for groups (optional)
        expand - If specified, it causes additional metadata to be included in the response. (optional)
        Returns:
        GroupList

      • listGroups

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups")
GroupList listGroups()
        List Groups Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.
        Returns:
        GroupList

      • createGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups")
Group createGroup​(Group group)
        Add Group Adds a new group with `OKTA_GROUP` type to your organization.
        Parameters:
        group - (required)
        Returns:
        Group

      • listGroupRules

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/rules")
GroupRuleList listGroupRules​(java.lang.String search,
                             java.lang.String expand)
        List Group Rules Lists all group rules for your organization.
        Parameters:
        search - Specifies the keyword to search fules for (optional)
        expand - If specified as `groupIdToGroupNameMap`, then show group names (optional)
        Returns:
        GroupRuleList

      • listGroupRules

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/rules")
GroupRuleList listGroupRules()
        List Group Rules Lists all group rules for your organization.
        Returns:
        GroupRuleList

      • createGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups/rules")
GroupRule createGroupRule​(GroupRule groupRule)
        Create Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition
        Parameters:
        groupRule - (required)
        Returns:
        GroupRule

      • deleteGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
void deleteGroupRule​(java.lang.String ruleId,
                     java.lang.Boolean removeUsers)
        Delete a group Rule Removes a specific group rule by id from your organization
        Parameters:
        ruleId - (required)
        removeUsers - Indicates whether to keep or remove users from groups assigned by this rule. (optional)

      • deleteGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
void deleteGroupRule​(java.lang.String ruleId)
        Delete a group Rule Removes a specific group rule by id from your organization
        Parameters:
        ruleId - (required)

      • getGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/rules/{ruleId}")
GroupRule getGroupRule​(java.lang.String ruleId,
                       java.lang.String expand)
        Get Group Rule Fetches a specific group rule by id from your organization
        Parameters:
        ruleId - (required)
        expand - (optional)
        Returns:
        GroupRule

      • getGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/rules/{ruleId}")
GroupRule getGroupRule​(java.lang.String ruleId)
        Get Group Rule Fetches a specific group rule by id from your organization
        Parameters:
        ruleId - (required)
        Returns:
        GroupRule

      • updateGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/rules/{ruleId}")
GroupRule updateGroupRule​(GroupRule groupRule,
                          java.lang.String ruleId)
        Update Group Rule Updates a group rule. Only `INACTIVE` rules can be updated.
        Parameters:
        groupRule - (required)
        ruleId - (required)
        Returns:
        GroupRule

      • activateGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/activate")
void activateGroupRule​(java.lang.String ruleId)
        Activate a group Rule Activates a specific group rule by id from your organization
        Parameters:
        ruleId - (required)

      • deactivateGroupRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/deactivate")
void deactivateGroupRule​(java.lang.String ruleId)
        Deactivate a group Rule Deactivates a specific group rule by id from your organization
        Parameters:
        ruleId - (required)

      • deleteGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}")
void deleteGroup​(java.lang.String groupId)
        Remove Group Removes a group with `OKTA_GROUP` type from your organization.
        Parameters:
        groupId - (required)

      • getGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}")
Group getGroup​(java.lang.String groupId)
        List Group Rules Fetches a group from your organization.
        Parameters:
        groupId - (required)
        Returns:
        Group

      • updateGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/{groupId}")
Group updateGroup​(Group group,
                  java.lang.String groupId)
        Update Group Updates the profile for a group with `OKTA_GROUP` type from your organization.
        Parameters:
        group - (required)
        groupId - (required)
        Returns:
        Group

      • listAssignedApplicationsForGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/apps")
ApplicationList listAssignedApplicationsForGroup​(java.lang.String groupId)
        List Assigned Applications Enumerates all applications that are assigned to a group.
        Parameters:
        groupId - (required)
        Returns:
        ApplicationList

      • listGroupAssignedRoles

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/roles")
RoleList listGroupAssignedRoles​(java.lang.String groupId,
                                java.lang.String expand)
        List Group Assigned Roles Success
        Parameters:
        groupId - (required)
        expand - (optional)
        Returns:
        RoleList

      • listGroupAssignedRoles

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/roles")
RoleList listGroupAssignedRoles​(java.lang.String groupId)
        List Group Assigned Roles Success
        Parameters:
        groupId - (required)
        Returns:
        RoleList

      • assignRoleToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups/{groupId}/roles")
Role assignRoleToGroup​(AssignRoleRequest assignRoleRequest,
                       java.lang.String groupId,
                       java.lang.Boolean disableNotifications)
        Assign Role to Group Assigns a Role to a Group
        Parameters:
        assignRoleRequest - (required)
        groupId - (required)
        disableNotifications - (optional)
        Returns:
        Role

      • assignRoleToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/groups/{groupId}/roles")
Role assignRoleToGroup​(AssignRoleRequest assignRoleRequest,
                       java.lang.String groupId)
        Assign Role to Group Assigns a Role to a Group
        Parameters:
        assignRoleRequest - (required)
        groupId - (required)
        Returns:
        Role

      • removeRoleFromGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}")
void removeRoleFromGroup​(java.lang.String groupId,
                         java.lang.String roleId)
        Remove Role from Group Unassigns a Role from a Group
        Parameters:
        groupId - (required)
        roleId - (required)

      • getRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}")
Role getRole​(java.lang.String groupId,
             java.lang.String roleId)
        Get Role Success
        Parameters:
        groupId - (required)
        roleId - (required)
        Returns:
        Role

      • listApplicationTargetsForApplicationAdministratorRoleForGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps")
CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForGroup​(java.lang.String groupId,
                                                                                     java.lang.String roleId)
        List Application Targets for Application Administrator Role for Group Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.
        Parameters:
        groupId - (required)
        roleId - (required)
        Returns:
        CatalogApplicationList

      • removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}")
void removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup​(java.lang.String groupId,
                                                                         java.lang.String roleId,
                                                                         java.lang.String appName)
        Remove Application Target from Application Administrator Role Given to Group Success
        Parameters:
        groupId - (required)
        roleId - (required)
        appName - (required)

      • addApplicationTargetToAdminRoleGivenToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}")
void addApplicationTargetToAdminRoleGivenToGroup​(java.lang.String groupId,
                                                 java.lang.String roleId,
                                                 java.lang.String appName)
        Add Application Target to Admin Role Given to Group Success
        Parameters:
        groupId - (required)
        roleId - (required)
        appName - (required)

      • removeApplicationTargetFromAdministratorRoleGivenToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
void removeApplicationTargetFromAdministratorRoleGivenToGroup​(java.lang.String groupId,
                                                              java.lang.String roleId,
                                                              java.lang.String appName,
                                                              java.lang.String applicationId)
        Remove App Instance Target to App Administrator Role given to a Group Remove App Instance Target to App Administrator Role given to a Group
        Parameters:
        groupId - (required)
        roleId - (required)
        appName - (required)
        applicationId - (required)

      • addApplicationInstanceTargetToAppAdminRoleGivenToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
void addApplicationInstanceTargetToAppAdminRoleGivenToGroup​(java.lang.String groupId,
                                                            java.lang.String roleId,
                                                            java.lang.String appName,
                                                            java.lang.String applicationId)
        Add App Instance Target to App Administrator Role given to a Group Add App Instance Target to App Administrator Role given to a Group
        Parameters:
        groupId - (required)
        roleId - (required)
        appName - (required)
        applicationId - (required)

      • listGroupTargetsForGroupRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups")
GroupList listGroupTargetsForGroupRole​(java.lang.String groupId,
                                       java.lang.String roleId)
        List Group Targets for Group Role Enumerates group targets for a group role.
        Parameters:
        groupId - (required)
        roleId - (required)
        Returns:
        GroupList

      • removeGroupTargetFromGroupAdministratorRoleGivenToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}")
void removeGroupTargetFromGroupAdministratorRoleGivenToGroup​(java.lang.String groupId,
                                                             java.lang.String roleId,
                                                             java.lang.String targetGroupId)
        Delete Group Target for Group Role remove group target for a group role.
        Parameters:
        groupId - (required)
        roleId - (required)
        targetGroupId - (required)

      • addGroupTargetToGroupAdministratorRoleForGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}")
void addGroupTargetToGroupAdministratorRoleForGroup​(java.lang.String groupId,
                                                    java.lang.String roleId,
                                                    java.lang.String targetGroupId)
        Add Group Target for Group Role Enumerates group targets for a group role.
        Parameters:
        groupId - (required)
        roleId - (required)
        targetGroupId - (required)

      • listGroupUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/groups/{groupId}/users")
UserList listGroupUsers​(java.lang.String groupId)
        List Group Members Enumerates all users that are a member of a group.
        Parameters:
        groupId - (required)
        Returns:
        UserList

      • removeUserFromGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/groups/{groupId}/users/{userId}")
void removeUserFromGroup​(java.lang.String groupId,
                         java.lang.String userId)
        Remove User from Group Removes a user from a group with 'OKTA_GROUP' type.
        Parameters:
        groupId - (required)
        userId - (required)

      • addUserToGroup

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/groups/{groupId}/users/{userId}")
void addUserToGroup​(java.lang.String groupId,
                    java.lang.String userId)
        Add User to Group Adds a user to a group with 'OKTA_GROUP' type.
        Parameters:
        groupId - (required)
        userId - (required)

      • listIdentityProviders

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps")
IdentityProviderList listIdentityProviders​(java.lang.String q,
                                           java.lang.String type)
        List Identity Providers Enumerates IdPs in your organization 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)
        type - Filters IdPs by type (optional)
        Returns:
        IdentityProviderList

      • listIdentityProviders

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps")
IdentityProviderList listIdentityProviders()
        List Identity Providers Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.
        Returns:
        IdentityProviderList

      • createIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps")
IdentityProvider createIdentityProvider​(IdentityProvider identityProvider)
        Add Identity Provider Adds a new IdP to your organization.
        Parameters:
        identityProvider - (required)
        Returns:
        IdentityProvider

      • listIdentityProviderKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/credentials/keys")
JsonWebKeyList listIdentityProviderKeys()
        List Identity Provider Keys Enumerates IdP key credentials.
        Returns:
        JsonWebKeyList

      • createIdentityProviderKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/credentials/keys")
JsonWebKey createIdentityProviderKey​(JsonWebKey jsonWebKey)
        Add X.509 Certificate Public Key for Identity Providers Adds a new X.509 certificate credential to the IdP key store.
        Parameters:
        jsonWebKey - (required)
        Returns:
        JsonWebKey

      • deleteIdentityProviderKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/idps/credentials/keys/{keyId}")
void deleteIdentityProviderKey​(java.lang.String keyId)
        Delete Key Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP.
        Parameters:
        keyId - (required)

      • getIdentityProviderKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/credentials/keys/{keyId}")
JsonWebKey getIdentityProviderKey​(java.lang.String keyId)
        Get Identity Provider Key Gets a specific IdP Key Credential by `kid`
        Parameters:
        keyId - (required)
        Returns:
        JsonWebKey

      • deleteIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/idps/{idpId}")
void deleteIdentityProvider​(java.lang.String idpId)
        Delete Identity Provider Removes an IdP from your organization.
        Parameters:
        idpId - (required)

      • getIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}")
IdentityProvider getIdentityProvider​(java.lang.String idpId)
        Get Identity Provider Fetches an IdP by `id`.
        Parameters:
        idpId - (required)
        Returns:
        IdentityProvider

      • updateIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/idps/{idpId}")
IdentityProvider updateIdentityProvider​(IdentityProvider identityProvider,
                                        java.lang.String idpId)
        Update Identity Provider Updates the configuration for an IdP.
        Parameters:
        identityProvider - (required)
        idpId - (required)
        Returns:
        IdentityProvider

      • listCsrsForIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/credentials/csrs")
CsrList listCsrsForIdentityProvider​(java.lang.String idpId)
        List Certificate Signing Requests for IdP Enumerates Certificate Signing Requests for an IdP
        Parameters:
        idpId - (required)
        Returns:
        CsrList

      • generateCsrForIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/credentials/csrs")
Csr generateCsrForIdentityProvider​(CsrMetadata metadata,
                                   java.lang.String idpId)
        Generate Certificate Signing Request for IdP Generates a new key pair and returns a Certificate Signing Request for it.
        Parameters:
        metadata - (required)
        idpId - (required)
        Returns:
        Csr

      • revokeCsrForIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
void revokeCsrForIdentityProvider​(java.lang.String idpId,
                                  java.lang.String csrId)
        Revoke Csr for Identity Provider Revoke a Certificate Signing Request and delete the key pair from the IdP
        Parameters:
        idpId - (required)
        csrId - (required)

      • getCsrForIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/credentials/csrs/{csrId}")
Csr getCsrForIdentityProvider​(java.lang.String idpId,
                              java.lang.String csrId)
        Get Csr for Identity Provider Gets a specific Certificate Signing Request model by id
        Parameters:
        idpId - (required)
        csrId - (required)
        Returns:
        Csr

      • publishCsrForIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish")
JsonWebKey publishCsrForIdentityProvider​(java.io.InputStream body,
                                         java.lang.String idpId,
                                         java.lang.String csrId)
        Publish Csr for Identity Provider Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
        Parameters:
        body - (required)
        idpId - (required)
        csrId - (required)
        Returns:
        JsonWebKey

      • listIdentityProviderSigningKeys

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/credentials/keys")
JsonWebKeyList listIdentityProviderSigningKeys​(java.lang.String idpId)
        List Signing Key Credentials for IdP Enumerates signing key credentials for an IdP
        Parameters:
        idpId - (required)
        Returns:
        JsonWebKeyList

      • generateIdentityProviderSigningKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/generate")
JsonWebKey generateIdentityProviderSigningKey​(java.lang.String idpId,
                                              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:
        idpId - (required)
        validityYears - expiry of the IdP Key Credential (required)
        Returns:
        JsonWebKey

      • getIdentityProviderSigningKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/credentials/keys/{keyId}")
JsonWebKey getIdentityProviderSigningKey​(java.lang.String idpId,
                                         java.lang.String keyId)
        Get Signing Key Credential for IdP Gets a specific IdP Key Credential by `kid`
        Parameters:
        idpId - (required)
        keyId - (required)
        Returns:
        JsonWebKey

      • cloneIdentityProviderKey

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/credentials/keys/{keyId}/clone")
JsonWebKey cloneIdentityProviderKey​(java.lang.String idpId,
                                    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:
        idpId - (required)
        keyId - (required)
        targetIdpId - (required)
        Returns:
        JsonWebKey

      • activateIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/lifecycle/activate")
IdentityProvider activateIdentityProvider​(java.lang.String idpId)
        Activate Identity Provider Activates an inactive IdP.
        Parameters:
        idpId - (required)
        Returns:
        IdentityProvider

      • deactivateIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/lifecycle/deactivate")
IdentityProvider deactivateIdentityProvider​(java.lang.String idpId)
        Deactivate Identity Provider Deactivates an active IdP.
        Parameters:
        idpId - (required)
        Returns:
        IdentityProvider

      • listIdentityProviderApplicationUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/users")
IdentityProviderApplicationUserList listIdentityProviderApplicationUsers​(java.lang.String idpId)
        Find Users Find all the users linked to an identity provider
        Parameters:
        idpId - (required)
        Returns:
        IdentityProviderApplicationUserList

      • unlinkUserFromIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/idps/{idpId}/users/{userId}")
void unlinkUserFromIdentityProvider​(java.lang.String idpId,
                                    java.lang.String userId)
        Unlink User from IdP Removes the link between the Okta user and the IdP user.
        Parameters:
        idpId - (required)
        userId - (required)

      • getIdentityProviderApplicationUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}")
IdentityProviderApplicationUser getIdentityProviderApplicationUser​(java.lang.String idpId,
                                                                   java.lang.String userId)
        Get Identity Provider Application User Fetches a linked IdP user by ID
        Parameters:
        idpId - (required)
        userId - (required)
        Returns:
        IdentityProviderApplicationUser

      • linkUserToIdentityProvider

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/idps/{idpId}/users/{userId}")
IdentityProviderApplicationUser linkUserToIdentityProvider​(UserIdentityProviderLinkRequest userIdentityProviderLinkRequest,
                                                           java.lang.String idpId,
                                                           java.lang.String userId)
        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:
        userIdentityProviderLinkRequest - (required)
        idpId - (required)
        userId - (required)
        Returns:
        IdentityProviderApplicationUser

      • listSocialAuthTokens

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/idps/{idpId}/users/{userId}/credentials/tokens")
SocialAuthTokenList listSocialAuthTokens​(java.lang.String idpId,
                                         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:
        idpId - (required)
        userId - (required)
        Returns:
        SocialAuthTokenList

      • listInlineHooks

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/inlineHooks")
InlineHookList listInlineHooks​(java.lang.String type)
        List Inline Hooks Success
        Parameters:
        type - (optional)
        Returns:
        InlineHookList

      • listInlineHooks

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/inlineHooks")
InlineHookList listInlineHooks()
        List Inline Hooks Success
        Returns:
        InlineHookList

      • createInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/inlineHooks")
InlineHook createInlineHook​(InlineHook inlineHook)
        Create Inline Hook Success
        Parameters:
        inlineHook - (required)
        Returns:
        InlineHook

      • deleteInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/inlineHooks/{inlineHookId}")
void deleteInlineHook​(java.lang.String inlineHookId)
        Delete Inline Hook Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.
        Parameters:
        inlineHookId - (required)

      • getInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/inlineHooks/{inlineHookId}")
InlineHook getInlineHook​(java.lang.String inlineHookId)
        Get Inline Hook Gets an inline hook by ID
        Parameters:
        inlineHookId - (required)
        Returns:
        InlineHook

      • updateInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/inlineHooks/{inlineHookId}")
InlineHook updateInlineHook​(InlineHook inlineHook,
                            java.lang.String inlineHookId)
        Update Inline Hook Updates an inline hook by ID
        Parameters:
        inlineHook - (required)
        inlineHookId - (required)
        Returns:
        InlineHook

      • executeInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/execute")
InlineHookResponse executeInlineHook​(InlineHookPayload payloadData,
                                     java.lang.String inlineHookId)
        Execute Inline Hook Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.
        Parameters:
        payloadData - (required)
        inlineHookId - (required)
        Returns:
        InlineHookResponse

      • activateInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate")
InlineHook activateInlineHook​(java.lang.String inlineHookId)
        Activate Inline Hook Activates the Inline Hook matching the provided id
        Parameters:
        inlineHookId - (required)
        Returns:
        InlineHook

      • deactivateInlineHook

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate")
InlineHook deactivateInlineHook​(java.lang.String inlineHookId)
        Deactivate Inline Hook Deactivates the Inline Hook matching the provided id
        Parameters:
        inlineHookId - (required)
        Returns:
        InlineHook

      • getLogs

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/logs")
LogEventList getLogs​(java.util.Date since,
                     java.util.Date until,
                     java.lang.String filter,
                     java.lang.String q,
                     java.lang.String sortOrder)
        Fetch a list of events from your Okta organization system log. The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API
        Parameters:
        since - (optional)
        until - (optional)
        filter - (optional)
        q - (optional)
        sortOrder - (optional, default to ASCENDING)
        Returns:
        LogEventList

      • getLogs

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/logs")
LogEventList getLogs()
        Fetch a list of events from your Okta organization system log. The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API
        Returns:
        LogEventList

      • listProfileMappings

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/mappings")
ProfileMappingList listProfileMappings​(java.lang.String sourceId,
                                       java.lang.String targetId)
        List Profile Mappings Enumerates Profile Mappings in your organization with pagination.
        Parameters:
        sourceId - (optional)
        targetId - (optional)
        Returns:
        ProfileMappingList

      • listProfileMappings

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/mappings")
ProfileMappingList listProfileMappings()
        List Profile Mappings Enumerates Profile Mappings in your organization with pagination.
        Returns:
        ProfileMappingList

      • getProfileMapping

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/mappings/{mappingId}")
ProfileMapping getProfileMapping​(java.lang.String mappingId)
        Get Profile Mapping Fetches a single Profile Mapping referenced by its ID.
        Parameters:
        mappingId - (required)
        Returns:
        ProfileMapping

      • updateProfileMapping

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/mappings/{mappingId}")
ProfileMapping updateProfileMapping​(ProfileMapping profileMapping,
                                    java.lang.String mappingId)
        Update Profile Mapping Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.
        Parameters:
        profileMapping - (required)
        mappingId - (required)
        Returns:
        ProfileMapping

      • getApplicationUserSchema

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/schemas/apps/{appInstanceId}/default")
UserSchema getApplicationUserSchema​(java.lang.String appInstanceId)
        Fetches the Schema for an App User Fetches the Schema for an App User
        Parameters:
        appInstanceId - (required)
        Returns:
        UserSchema

      • updateApplicationUserProfile

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
UserSchema updateApplicationUserProfile​(java.lang.String appInstanceId,
                                        UserSchema body)
        Partial updates on the User Profile properties of the Application User Schema. Partial updates on the User Profile properties of the Application User Schema.
        Parameters:
        appInstanceId - (required)
        body - (optional)
        Returns:
        UserSchema

      • updateApplicationUserProfile

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
UserSchema updateApplicationUserProfile​(java.lang.String appInstanceId)
        Partial updates on the User Profile properties of the Application User Schema. Partial updates on the User Profile properties of the Application User Schema.
        Parameters:
        appInstanceId - (required)
        Returns:
        UserSchema

      • getGroupSchema

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/schemas/group/default")
GroupSchema getGroupSchema()
        Fetches the group schema Fetches the group schema
        Returns:
        GroupSchema

      • updateGroupSchema

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/group/default")
GroupSchema updateGroupSchema​(GroupSchema body)
        Updates, adds ore removes one or more custom Group Profile properties in the schema Updates, adds ore removes one or more custom Group Profile properties in the schema
        Parameters:
        body - (optional)
        Returns:
        GroupSchema

      • updateGroupSchema

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/group/default")
GroupSchema updateGroupSchema()
        Updates, adds ore removes one or more custom Group Profile properties in the schema Updates, adds ore removes one or more custom Group Profile properties in the schema
        Returns:
        GroupSchema

      • listLinkedObjectDefinitions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects")
LinkedObjectList listLinkedObjectDefinitions()
        List Linked Object Definitions Success
        Returns:
        LinkedObjectList

      • addLinkedObjectDefinition

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/user/linkedObjects")
LinkedObject addLinkedObjectDefinition​(LinkedObject linkedObject)
        Add Linked Object Definition Success
        Parameters:
        linkedObject - (required)
        Returns:
        LinkedObject

      • deleteLinkedObjectDefinition

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}")
void deleteLinkedObjectDefinition​(java.lang.String linkedObjectName)
        Delete Linked Object Definition Success
        Parameters:
        linkedObjectName - (required)

      • getLinkedObjectDefinition

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}")
LinkedObject getLinkedObjectDefinition​(java.lang.String linkedObjectName)
        Get Linked Object Definition Success
        Parameters:
        linkedObjectName - (required)
        Returns:
        LinkedObject

      • getUserSchema

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/schemas/user/{schemaId}")
UserSchema getUserSchema​(java.lang.String schemaId)
        Fetches the schema for a Schema Id. Fetches the schema for a Schema Id.
        Parameters:
        schemaId - (required)
        Returns:
        UserSchema

      • updateUserProfile

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/schemas/user/{schemaId}")
UserSchema updateUserProfile​(UserSchema userSchema,
                             java.lang.String schemaId)
        Update User Profile Partial updates on the User Profile properties of the user schema.
        Parameters:
        userSchema - (required)
        schemaId - (required)
        Returns:
        UserSchema

      • listUserTypes

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/types/user")
UserTypeList listUserTypes()
        List User Types Fetches all User Types in your org
        Returns:
        UserTypeList

      • createUserType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/types/user")
UserType createUserType​(UserType userType)
        Create User Type Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.
        Parameters:
        userType - (required)
        Returns:
        UserType

      • deleteUserType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/meta/types/user/{typeId}")
void deleteUserType​(java.lang.String typeId)
        Delete User Type Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users
        Parameters:
        typeId - (required)

      • getUserType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/meta/types/user/{typeId}")
UserType getUserType​(java.lang.String typeId)
        Get User Type Fetches a User Type by ID. The special identifier `default` may be used to fetch the default User Type.
        Parameters:
        typeId - (required)
        Returns:
        UserType

      • updateUserType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/meta/types/user/{typeId}")
UserType updateUserType​(UserType userType,
                        java.lang.String typeId)
        Update User Type Updates an existing User Type
        Parameters:
        userType - (required)
        typeId - (required)
        Returns:
        UserType

      • replaceUserType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/meta/types/user/{typeId}")
UserType replaceUserType​(UserType userType,
                         java.lang.String typeId)
        Replace User Type Replace an existing User Type
        Parameters:
        userType - (required)
        typeId - (required)
        Returns:
        UserType

      • getOrgSettings

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org")
OrgSetting getOrgSettings()
        Get org settings Get settings of your organization.
        Returns:
        OrgSetting

      • partialUpdateOrgSetting

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org")
OrgSetting partialUpdateOrgSetting​(OrgSetting body)
        Partial update Org Setting Partial update settings of your organization.
        Parameters:
        body - (optional)
        Returns:
        OrgSetting

      • partialUpdateOrgSetting

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org")
OrgSetting partialUpdateOrgSetting()
        Partial update Org Setting Partial update settings of your organization.
        Returns:
        OrgSetting

      • updateOrgSetting

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/org")
OrgSetting updateOrgSetting​(OrgSetting orgSetting)
        Update Org setting Update settings of your organization.
        Parameters:
        orgSetting - (required)
        Returns:
        OrgSetting

      • getOrgContactTypes

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org/contacts")
OrgContactTypeObjList getOrgContactTypes()
        Get org contact types Gets Contact Types of your organization.
        Returns:
        OrgContactTypeObjList

      • getOrgContactUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org/contacts/{contactType}")
OrgContactUser getOrgContactUser​(java.lang.String contactType)
        Get org contact user Retrieves the URL of the User associated with the specified Contact Type.
        Parameters:
        contactType - (required)
        Returns:
        OrgContactUser

      • updateOrgContactUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/org/contacts/{contactType}")
OrgContactUser updateOrgContactUser​(OrgContactUser orgContactUser,
                                    java.lang.String contactType)
        Update org contact user Updates the User associated with the specified Contact Type.
        Parameters:
        orgContactUser - (required)
        contactType - (required)
        Returns:
        OrgContactUser

      • bulkRemoveEmailAddressBounces

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/email/bounces/remove-list")
BouncesRemoveListResult bulkRemoveEmailAddressBounces​(BouncesRemoveListObj body)
        Remove Emails from Email Provider Bounce List A list of email addresses to be removed from the set of email addresses that are bounced.
        Parameters:
        body - (optional)
        Returns:
        BouncesRemoveListResult

      • bulkRemoveEmailAddressBounces

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/email/bounces/remove-list")
BouncesRemoveListResult bulkRemoveEmailAddressBounces()
        Remove Emails from Email Provider Bounce List A list of email addresses to be removed from the set of email addresses that are bounced.
        Returns:
        BouncesRemoveListResult

      • updateOrgLogo

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/logo")
void updateOrgLogo()
        Update org logo Updates the logo for your organization.

      • getOrgPreferences

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org/preferences")
OrgPreferences getOrgPreferences()
        Get org preferences Gets preferences of your organization.
        Returns:
        OrgPreferences

      • hideOktaUIFooter

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/preferences/hideEndUserFooter")
OrgPreferences hideOktaUIFooter()
        Show Okta UI Footer Hide the Okta UI footer for all end users of your organization.
        Returns:
        OrgPreferences

      • showOktaUIFooter

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/preferences/showEndUserFooter")
OrgPreferences showOktaUIFooter()
        Show Okta UI Footer Makes the Okta UI footer visible for all end users of your organization.
        Returns:
        OrgPreferences

      • getOktaCommunicationSettings

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org/privacy/oktaCommunication")
OrgOktaCommunicationSetting getOktaCommunicationSettings()
        Get Okta Communication Settings Gets Okta Communication Settings of your organization.
        Returns:
        OrgOktaCommunicationSetting

      • optInUsersToOktaCommunicationEmails

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/privacy/oktaCommunication/optIn")
OrgOktaCommunicationSetting optInUsersToOktaCommunicationEmails()
        Opt in all users to Okta Communication emails Opts in all users of this org to Okta Communication emails.
        Returns:
        OrgOktaCommunicationSetting

      • optOutUsersFromOktaCommunicationEmails

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/privacy/oktaCommunication/optOut")
OrgOktaCommunicationSetting optOutUsersFromOktaCommunicationEmails()
        Opt out all users from Okta Communication emails Opts out all users of this org from Okta Communication emails.
        Returns:
        OrgOktaCommunicationSetting

      • getOrgOktaSupportSettings

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/org/privacy/oktaSupport")
OrgOktaSupportSettingsObj getOrgOktaSupportSettings()
        Get Okta Support settings Gets Okta Support Settings of your organization.
        Returns:
        OrgOktaSupportSettingsObj

      • extendOktaSupport

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/privacy/oktaSupport/extend")
OrgOktaSupportSettingsObj extendOktaSupport()
        Extend Okta Support Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.
        Returns:
        OrgOktaSupportSettingsObj

      • grantOktaSupport

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/privacy/oktaSupport/grant")
OrgOktaSupportSettingsObj grantOktaSupport()
        Grant Okta Support Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours.
        Returns:
        OrgOktaSupportSettingsObj

      • revokeOktaSupport

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/org/privacy/oktaSupport/revoke")
OrgOktaSupportSettingsObj revokeOktaSupport()
        Extend Okta Support Revokes Okta Support access to your organization.
        Returns:
        OrgOktaSupportSettingsObj

      • listPolicies

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies")
PolicyList listPolicies​(java.lang.String type,
                        java.lang.String status,
                        java.lang.String expand)
        List Policies Gets all policies with the specified type.
        Parameters:
        type - (required)
        status - (optional)
        expand - (optional)
        Returns:
        PolicyList

      • listPolicies

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies")
PolicyList listPolicies​(java.lang.String type)
        List Policies Gets all policies with the specified type.
        Parameters:
        type - (required)
        Returns:
        PolicyList

      • createPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies")
Policy createPolicy​(Policy policy,
                    java.lang.Boolean activate)
        Create Policy Creates a policy.
        Parameters:
        policy - (required)
        activate - (optional, default to true)
        Returns:
        Policy

      • createPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies")
Policy createPolicy​(Policy policy)
        Create Policy Creates a policy.
        Parameters:
        policy - (required)
        Returns:
        Policy

      • deletePolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/policies/{policyId}")
void deletePolicy​(java.lang.String policyId)
        Delete Policy Removes a policy.
        Parameters:
        policyId - (required)

      • getPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies/{policyId}")
Policy getPolicy​(java.lang.String policyId,
                 java.lang.String expand)
        Get Policy Gets a policy.
        Parameters:
        policyId - (required)
        expand - (optional)
        Returns:
        Policy

      • getPolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies/{policyId}")
Policy getPolicy​(java.lang.String policyId)
        Get Policy Gets a policy.
        Parameters:
        policyId - (required)
        Returns:
        Policy

      • updatePolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/policies/{policyId}")
Policy updatePolicy​(Policy policy,
                    java.lang.String policyId)
        Update Policy Updates a policy.
        Parameters:
        policy - (required)
        policyId - (required)
        Returns:
        Policy

      • activatePolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/activate")
void activatePolicy​(java.lang.String policyId)
        Activate Policy Activates a policy.
        Parameters:
        policyId - (required)

      • deactivatePolicy

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies/{policyId}/lifecycle/deactivate")
void deactivatePolicy​(java.lang.String policyId)
        Deactivate Policy Deactivates a policy.
        Parameters:
        policyId - (required)

      • listPolicyRules

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies/{policyId}/rules")
PolicyRuleList listPolicyRules​(java.lang.String policyId)
        List Policy Rules Enumerates all policy rules.
        Parameters:
        policyId - (required)
        Returns:
        PolicyRuleList

      • createPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies/{policyId}/rules")
PolicyRule createPolicyRule​(PolicyRule policyRule,
                            java.lang.String policyId)
        Create Policy Rule Creates a policy rule.
        Parameters:
        policyRule - (required)
        policyId - (required)
        Returns:
        PolicyRule

      • deletePolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/policies/{policyId}/rules/{ruleId}")
void deletePolicyRule​(java.lang.String policyId,
                      java.lang.String ruleId)
        Delete Policy Rule Removes a policy rule.
        Parameters:
        policyId - (required)
        ruleId - (required)

      • getPolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/policies/{policyId}/rules/{ruleId}")
PolicyRule getPolicyRule​(java.lang.String policyId,
                         java.lang.String ruleId)
        Get Policy Rule Gets a policy rule.
        Parameters:
        policyId - (required)
        ruleId - (required)
        Returns:
        PolicyRule

      • updatePolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/policies/{policyId}/rules/{ruleId}")
PolicyRule updatePolicyRule​(PolicyRule policyRule,
                            java.lang.String policyId,
                            java.lang.String ruleId)
        Update Policy Rule Updates a policy rule.
        Parameters:
        policyRule - (required)
        policyId - (required)
        ruleId - (required)
        Returns:
        PolicyRule

      • activatePolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/activate")
void activatePolicyRule​(java.lang.String policyId,
                        java.lang.String ruleId)
        Activate Policy Rule Activates a policy rule.
        Parameters:
        policyId - (required)
        ruleId - (required)

      • deactivatePolicyRule

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate")
void deactivatePolicyRule​(java.lang.String policyId,
                          java.lang.String ruleId)
        Deactivate Policy Rule Deactivates a policy rule.
        Parameters:
        policyId - (required)
        ruleId - (required)

      • listRoleSubscriptions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions")
SubscriptionList listRoleSubscriptions​(java.lang.String roleTypeOrRoleId)
        List all subscriptions of a Custom Role When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role
        Parameters:
        roleTypeOrRoleId - (required)
        Returns:
        SubscriptionList

      • getRoleSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}")
Subscription getRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                   java.lang.String notificationType)
        Get subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.
        Parameters:
        roleTypeOrRoleId - (required)
        notificationType - (required)
        Returns:
        Subscription

      • subscribeRoleSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe")
void subscribeRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                 java.lang.String notificationType)
        Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.
        Parameters:
        roleTypeOrRoleId - (required)
        notificationType - (required)

      • unsubscribeRoleSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                   java.lang.String notificationType)
        Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.
        Parameters:
        roleTypeOrRoleId - (required)
        notificationType - (required)

      • createSession

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/sessions")
Session createSession​(CreateSessionRequest createSessionRequest)
        Create Session with Session Token Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.
        Parameters:
        createSessionRequest - (required)
        Returns:
        Session

      • endSession

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/sessions/{sessionId}")
void endSession​(java.lang.String sessionId)
        End Session End a session.
        Parameters:
        sessionId - (required)

      • getSession

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/sessions/{sessionId}")
Session getSession​(java.lang.String sessionId)
        Get Session Get details about a session.
        Parameters:
        sessionId - (required)
        Returns:
        Session

      • refreshSession

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/sessions/{sessionId}/lifecycle/refresh")
Session refreshSession​(java.lang.String sessionId)
        Refresh Session Refresh a session.
        Parameters:
        sessionId - (required)
        Returns:
        Session

      • listSmsTemplates

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/templates/sms")
SmsTemplateList listSmsTemplates​(SmsTemplateType templateType)
        List SMS Templates Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.
        Parameters:
        templateType - (optional)
        Returns:
        SmsTemplateList

      • listSmsTemplates

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/templates/sms")
SmsTemplateList listSmsTemplates()
        List SMS Templates Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.
        Returns:
        SmsTemplateList

      • createSmsTemplate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/templates/sms")
SmsTemplate createSmsTemplate​(SmsTemplate smsTemplate)
        Add SMS Template Adds a new custom SMS template to your organization.
        Parameters:
        smsTemplate - (required)
        Returns:
        SmsTemplate

      • deleteSmsTemplate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/templates/sms/{templateId}")
void deleteSmsTemplate​(java.lang.String templateId)
        Remove SMS Template Removes an SMS template.
        Parameters:
        templateId - (required)

      • getSmsTemplate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/templates/sms/{templateId}")
SmsTemplate getSmsTemplate​(java.lang.String templateId)
        Get SMS Template Fetches a specific template by `id`
        Parameters:
        templateId - (required)
        Returns:
        SmsTemplate

      • partialUpdateSmsTemplate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/templates/sms/{templateId}")
SmsTemplate partialUpdateSmsTemplate​(SmsTemplate smsTemplate,
                                     java.lang.String templateId)
        Partial SMS Template Update Updates only some of the SMS template properties:
        Parameters:
        smsTemplate - (required)
        templateId - (required)
        Returns:
        SmsTemplate

      • updateSmsTemplate

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/templates/sms/{templateId}")
SmsTemplate updateSmsTemplate​(SmsTemplate smsTemplate,
                              java.lang.String templateId)
        Update SMS Template Updates the SMS template.
        Parameters:
        smsTemplate - (required)
        templateId - (required)
        Returns:
        SmsTemplate

      • getCurrentConfiguration

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/threats/configuration")
ThreatInsightConfiguration getCurrentConfiguration()
        Get Current Configuration Gets current ThreatInsight configuration
        Returns:
        ThreatInsightConfiguration

      • updateConfiguration

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/threats/configuration")
ThreatInsightConfiguration updateConfiguration​(ThreatInsightConfiguration threatInsightConfiguration)
        Update Configuration Updates ThreatInsight configuration
        Parameters:
        threatInsightConfiguration - (required)
        Returns:
        ThreatInsightConfiguration

      • listOrigins

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/trustedOrigins")
TrustedOriginList listOrigins​(java.lang.String q,
                              java.lang.String filter)
        List Trusted Origins Success
        Parameters:
        q - (optional)
        filter - (optional)
        Returns:
        TrustedOriginList

      • listOrigins

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/trustedOrigins")
TrustedOriginList listOrigins()
        List Trusted Origins Success
        Returns:
        TrustedOriginList

      • createOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/trustedOrigins")
TrustedOrigin createOrigin​(TrustedOrigin trustedOrigin)
        Create Trusted Origin Success
        Parameters:
        trustedOrigin - (required)
        Returns:
        TrustedOrigin

      • deleteOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/trustedOrigins/{trustedOriginId}")
void deleteOrigin​(java.lang.String trustedOriginId)
        Delete Trusted Origin Success
        Parameters:
        trustedOriginId - (required)

      • getOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/trustedOrigins/{trustedOriginId}")
TrustedOrigin getOrigin​(java.lang.String trustedOriginId)
        Get Trusted Origin Success
        Parameters:
        trustedOriginId - (required)
        Returns:
        TrustedOrigin

      • updateOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/trustedOrigins/{trustedOriginId}")
TrustedOrigin updateOrigin​(TrustedOrigin trustedOrigin,
                           java.lang.String trustedOriginId)
        Update Trusted Origin Success
        Parameters:
        trustedOrigin - (required)
        trustedOriginId - (required)
        Returns:
        TrustedOrigin

      • activateOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate")
TrustedOrigin activateOrigin​(java.lang.String trustedOriginId)
        Activate Trusted Origin Success
        Parameters:
        trustedOriginId - (required)
        Returns:
        TrustedOrigin

      • deactivateOrigin

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate")
TrustedOrigin deactivateOrigin​(java.lang.String trustedOriginId)
        Deactivate Trusted Origin Success
        Parameters:
        trustedOriginId - (required)
        Returns:
        TrustedOrigin

      • listUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users")
UserList listUsers​(java.lang.String q,
                   java.lang.String filter,
                   java.lang.String search,
                   java.lang.String sortBy,
                   java.lang.String sortOrder)
        List Users Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.
        Parameters:
        q - Finds a user that matches firstName, lastName, and email properties (optional)
        filter - Filters users with a supported expression for a subset of properties (optional)
        search - Searches for users with a supported filtering expression for most properties (optional)
        sortBy - (optional)
        sortOrder - (optional)
        Returns:
        UserList

      • listUsers

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users")
UserList listUsers()
        List Users Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.
        Returns:
        UserList

      • createUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users")
User createUser​(CreateUserRequest body,
                java.lang.Boolean activate,
                java.lang.Boolean provider,
                UserNextLogin nextLogin)
        Create User Creates a new user in your Okta organization with or without credentials.
        Parameters:
        body - (required)
        activate - Executes activation lifecycle operation when creating the user (optional, default to true)
        provider - Indicates whether to create a user with a specified authentication provider (optional, default to false)
        nextLogin - With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional)
        Returns:
        User

      • createUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users")
User createUser​(CreateUserRequest body)
        Create User Creates a new user in your Okta organization with or without credentials.
        Parameters:
        body - (required)
        Returns:
        User

      • setLinkedObjectForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{associatedUserId}/linkedObjects/{primaryRelationshipName}/{primaryUserId}")
void setLinkedObjectForUser​(java.lang.String associatedUserId,
                            java.lang.String primaryRelationshipName,
                            java.lang.String primaryUserId)
        Set Linked Object for User Sets a linked object for a user.
        Parameters:
        associatedUserId - (required)
        primaryRelationshipName - (required)
        primaryUserId - (required)

      • deactivateOrDeleteUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}")
void deactivateOrDeleteUser​(java.lang.String userId,
                            java.lang.Boolean sendEmail)
        Delete User Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**
        Parameters:
        userId - (required)
        sendEmail - (optional, default to false)

      • deactivateOrDeleteUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}")
void deactivateOrDeleteUser​(java.lang.String userId)
        Delete User Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**
        Parameters:
        userId - (required)

      • getUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}")
User getUser​(java.lang.String userId)
        Get User Fetches a user from your Okta organization.
        Parameters:
        userId - (required)
        Returns:
        User

      • partialUpdateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}")
User partialUpdateUser​(User user,
                       java.lang.String userId,
                       java.lang.Boolean strict)
        Partial Update User Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.
        Parameters:
        user - (required)
        userId - (required)
        strict - (optional)
        Returns:
        User

      • partialUpdateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}")
User partialUpdateUser​(User user,
                       java.lang.String userId)
        Partial Update User Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.
        Parameters:
        user - (required)
        userId - (required)
        Returns:
        User

      • updateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}")
User updateUser​(User user,
                java.lang.String userId,
                java.lang.Boolean strict)
        Update User Update a user's profile and/or credentials using strict-update semantics.
        Parameters:
        user - (required)
        userId - (required)
        strict - (optional)
        Returns:
        User

      • updateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}")
User updateUser​(User user,
                java.lang.String userId)
        Update User Update a user's profile and/or credentials using strict-update semantics.
        Parameters:
        user - (required)
        userId - (required)
        Returns:
        User

      • listAppLinks

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/appLinks")
AppLinkList listAppLinks​(java.lang.String userId)
        Get Assigned App Links Fetches appLinks for all direct or indirect (via group membership) assigned applications.
        Parameters:
        userId - (required)
        Returns:
        AppLinkList

      • listUserClients

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients")
OAuth2ClientList listUserClients​(java.lang.String userId)
        List User Clients Lists all client resources for which the specified user has grants or tokens.
        Parameters:
        userId - (required)
        Returns:
        OAuth2ClientList

      • revokeGrantsForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/grants")
void revokeGrantsForUserAndClient​(java.lang.String userId,
                                  java.lang.String clientId)
        Revoke Grants for User and Client Revokes all grants for the specified user and client
        Parameters:
        userId - (required)
        clientId - (required)

      • listGrantsForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
OAuth2ScopeConsentGrantList listGrantsForUserAndClient​(java.lang.String userId,
                                                       java.lang.String clientId,
                                                       java.lang.String expand)
        List Grants for User and Client Lists all grants for a specified user and client
        Parameters:
        userId - (required)
        clientId - (required)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrantList

      • listGrantsForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
OAuth2ScopeConsentGrantList listGrantsForUserAndClient​(java.lang.String userId,
                                                       java.lang.String clientId)
        List Grants for User and Client Lists all grants for a specified user and client
        Parameters:
        userId - (required)
        clientId - (required)
        Returns:
        OAuth2ScopeConsentGrantList

      • revokeTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens")
void revokeTokensForUserAndClient​(java.lang.String userId,
                                  java.lang.String clientId)
        Revoke Tokens for User and Client Revokes all refresh tokens issued for the specified User and Client.
        Parameters:
        userId - (required)
        clientId - (required)

      • listRefreshTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForUserAndClient​(java.lang.String userId,
                                                         java.lang.String clientId,
                                                         java.lang.String expand)
        List Refresh Tokens for User and Client Lists all refresh tokens issued for the specified User and Client.
        Parameters:
        userId - (required)
        clientId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshTokenList

      • listRefreshTokensForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens")
OAuth2RefreshTokenList listRefreshTokensForUserAndClient​(java.lang.String userId,
                                                         java.lang.String clientId)
        List Refresh Tokens for User and Client Lists all refresh tokens issued for the specified User and Client.
        Parameters:
        userId - (required)
        clientId - (required)
        Returns:
        OAuth2RefreshTokenList

      • revokeTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
void revokeTokenForUserAndClient​(java.lang.String userId,
                                 java.lang.String clientId,
                                 java.lang.String tokenId)
        Revoke Token for User and Client Revokes the specified refresh token.
        Parameters:
        userId - (required)
        clientId - (required)
        tokenId - (required)

      • getRefreshTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForUserAndClient​(java.lang.String userId,
                                                   java.lang.String clientId,
                                                   java.lang.String tokenId,
                                                   java.lang.String expand)
        Get Refresh Token for User and Client Gets a refresh token issued for the specified User and Client.
        Parameters:
        userId - (required)
        clientId - (required)
        tokenId - (required)
        expand - (optional)
        Returns:
        OAuth2RefreshToken

      • getRefreshTokenForUserAndClient

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId}")
OAuth2RefreshToken getRefreshTokenForUserAndClient​(java.lang.String userId,
                                                   java.lang.String clientId,
                                                   java.lang.String tokenId)
        Get Refresh Token for User and Client Gets a refresh token issued for the specified User and Client.
        Parameters:
        userId - (required)
        clientId - (required)
        tokenId - (required)
        Returns:
        OAuth2RefreshToken

      • changePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
UserCredentials changePassword​(ChangePasswordRequest changePasswordRequest,
                               java.lang.String userId,
                               java.lang.Boolean strict)
        Change Password Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential
        Parameters:
        changePasswordRequest - (required)
        userId - (required)
        strict - (optional)
        Returns:
        UserCredentials

      • changePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/change_password")
UserCredentials changePassword​(ChangePasswordRequest changePasswordRequest,
                               java.lang.String userId)
        Change Password Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential
        Parameters:
        changePasswordRequest - (required)
        userId - (required)
        Returns:
        UserCredentials

      • changeRecoveryQuestion

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/change_recovery_question")
UserCredentials changeRecoveryQuestion​(UserCredentials userCredentials,
                                       java.lang.String userId)
        Change Recovery Question Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential
        Parameters:
        userCredentials - (required)
        userId - (required)
        Returns:
        UserCredentials

      • forgotPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
ForgotPasswordResponse forgotPassword​(java.lang.String userId,
                                      java.lang.Boolean sendEmail)
        Initiate Forgot Password Initiate forgot password flow. Generates a one-time token (OTT) that can be used to reset a user's password.
        Parameters:
        userId - (required)
        sendEmail - (optional, default to true)
        Returns:
        ForgotPasswordResponse

      • forgotPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password")
ForgotPasswordResponse forgotPassword​(java.lang.String userId)
        Initiate Forgot Password Initiate forgot password flow. Generates a one-time token (OTT) that can be used to reset a user's password.
        Parameters:
        userId - (required)
        Returns:
        ForgotPasswordResponse

      • forgotPasswordSetNewPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password_recovery_question")
UserCredentials forgotPasswordSetNewPassword​(UserCredentials userCredentials,
                                             java.lang.String userId,
                                             java.lang.Boolean sendEmail)
        Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct.
        Parameters:
        userCredentials - (required)
        userId - (required)
        sendEmail - (optional, default to true)
        Returns:
        UserCredentials

      • forgotPasswordSetNewPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/credentials/forgot_password_recovery_question")
UserCredentials forgotPasswordSetNewPassword​(UserCredentials userCredentials,
                                             java.lang.String userId)
        Reset Password with Recovery Question Resets the user's password to the specified password if the provided answer to the recovery question is correct.
        Parameters:
        userCredentials - (required)
        userId - (required)
        Returns:
        UserCredentials

      • listFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/factors")
UserFactorList listFactors​(java.lang.String userId)
        List Factors Enumerates all the enrolled factors for the specified user
        Parameters:
        userId - (required)
        Returns:
        UserFactorList

      • enrollFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors")
UserFactor enrollFactor​(UserFactor body,
                        java.lang.String userId,
                        java.lang.Boolean updatePhone,
                        java.lang.String templateId,
                        java.lang.Integer tokenLifetimeSeconds,
                        java.lang.Boolean activate)
        Enroll Factor Enrolls a user with a supported factor.
        Parameters:
        body - Factor (required)
        userId - (required)
        updatePhone - (optional, default to false)
        templateId - id of SMS template (only for SMS factor) (optional)
        tokenLifetimeSeconds - (optional, default to 300)
        activate - (optional, default to false)
        Returns:
        UserFactor

      • enrollFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors")
UserFactor enrollFactor​(UserFactor body,
                        java.lang.String userId)
        Enroll Factor Enrolls a user with a supported factor.
        Parameters:
        body - Factor (required)
        userId - (required)
        Returns:
        UserFactor

      • listSupportedFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/factors/catalog")
UserFactorList listSupportedFactors​(java.lang.String userId)
        List Supported Factors Enumerates all the supported factors that can be enrolled for the specified user
        Parameters:
        userId - (required)
        Returns:
        UserFactorList

      • listSupportedSecurityQuestions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/factors/questions")
SecurityQuestionList listSupportedSecurityQuestions​(java.lang.String userId)
        List Supported Security Questions Enumerates all available security questions for a user's `question` factor
        Parameters:
        userId - (required)
        Returns:
        SecurityQuestionList

      • deleteFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/factors/{factorId}")
void deleteFactor​(java.lang.String userId,
                  java.lang.String factorId)
        Delete Factor Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.
        Parameters:
        userId - (required)
        factorId - (required)

      • getFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}")
UserFactor getFactor​(java.lang.String userId,
                     java.lang.String factorId)
        Get Factor Fetches a factor for the specified user
        Parameters:
        userId - (required)
        factorId - (required)
        Returns:
        UserFactor

      • activateFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
UserFactor activateFactor​(java.lang.String userId,
                          java.lang.String factorId,
                          ActivateFactorRequest body)
        Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
        Parameters:
        userId - (required)
        factorId - (required)
        body - (optional)
        Returns:
        UserFactor

      • activateFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/lifecycle/activate")
UserFactor activateFactor​(java.lang.String userId,
                          java.lang.String factorId)
        Activate Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.
        Parameters:
        userId - (required)
        factorId - (required)
        Returns:
        UserFactor

      • getFactorTransactionStatus

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}")
VerifyUserFactorResponse getFactorTransactionStatus​(java.lang.String userId,
                                                    java.lang.String factorId,
                                                    java.lang.String transactionId)
        Get Factor Transaction Status Polls factors verification transaction for status.
        Parameters:
        userId - (required)
        factorId - (required)
        transactionId - (required)
        Returns:
        VerifyUserFactorResponse

      • verifyFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
VerifyUserFactorResponse verifyFactor​(java.lang.String userId,
                                      java.lang.String factorId,
                                      VerifyFactorRequest body,
                                      java.lang.String templateId,
                                      java.lang.Integer tokenLifetimeSeconds,
                                      java.lang.String xForwardedFor,
                                      java.lang.String userAgent,
                                      java.lang.String acceptLanguage)
        Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
        Parameters:
        userId - (required)
        factorId - (required)
        body - (optional)
        templateId - (optional)
        tokenLifetimeSeconds - (optional, default to 300)
        xForwardedFor - (optional)
        userAgent - (optional)
        acceptLanguage - (optional)
        Returns:
        VerifyUserFactorResponse

      • verifyFactor

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/factors/{factorId}/verify")
VerifyUserFactorResponse verifyFactor​(java.lang.String userId,
                                      java.lang.String factorId)
        Verify MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
        Parameters:
        userId - (required)
        factorId - (required)
        Returns:
        VerifyUserFactorResponse

      • revokeUserGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/grants")
void revokeUserGrants​(java.lang.String userId)
        Revoke User Grants Revokes all grants for a specified user
        Parameters:
        userId - (required)

      • listUserGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/grants")
OAuth2ScopeConsentGrantList listUserGrants​(java.lang.String userId,
                                           java.lang.String scopeId,
                                           java.lang.String expand)
        List User Grants Lists all grants for the specified user
        Parameters:
        userId - (required)
        scopeId - (optional)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrantList

      • listUserGrants

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/grants")
OAuth2ScopeConsentGrantList listUserGrants​(java.lang.String userId)
        List User Grants Lists all grants for the specified user
        Parameters:
        userId - (required)
        Returns:
        OAuth2ScopeConsentGrantList

      • revokeUserGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/grants/{grantId}")
void revokeUserGrant​(java.lang.String userId,
                     java.lang.String grantId)
        Revoke User Grant Revokes one grant for a specified user
        Parameters:
        userId - (required)
        grantId - (required)

      • getUserGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
OAuth2ScopeConsentGrant getUserGrant​(java.lang.String userId,
                                     java.lang.String grantId,
                                     java.lang.String expand)
        Get User Grant Gets a grant for the specified user
        Parameters:
        userId - (required)
        grantId - (required)
        expand - (optional)
        Returns:
        OAuth2ScopeConsentGrant

      • getUserGrant

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
OAuth2ScopeConsentGrant getUserGrant​(java.lang.String userId,
                                     java.lang.String grantId)
        Get User Grant Gets a grant for the specified user
        Parameters:
        userId - (required)
        grantId - (required)
        Returns:
        OAuth2ScopeConsentGrant

      • listUserGroups

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/groups")
GroupList listUserGroups​(java.lang.String userId)
        Get Member Groups Fetches the groups of which the user is a member.
        Parameters:
        userId - (required)
        Returns:
        GroupList

      • listUserIdentityProviders

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/idps")
IdentityProviderList listUserIdentityProviders​(java.lang.String userId)
        Listing IdPs associated with a user Lists the IdPs associated with the user.
        Parameters:
        userId - (required)
        Returns:
        IdentityProviderList

      • activateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/activate")
UserActivationToken activateUser​(java.lang.String userId,
                                 java.lang.Boolean sendEmail)
        Activate User Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete.
        Parameters:
        userId - (required)
        sendEmail - Sends an activation email to the user if true (required)
        Returns:
        UserActivationToken

      • deactivateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
void deactivateUser​(java.lang.String userId,
                    java.lang.Boolean sendEmail)
        Deactivate User Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete.
        Parameters:
        userId - (required)
        sendEmail - (optional, default to false)

      • deactivateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/deactivate")
void deactivateUser​(java.lang.String userId)
        Deactivate User Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete.
        Parameters:
        userId - (required)

      • expirePassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password")
User expirePassword​(java.lang.String userId)
        Expire Password This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login.
        Parameters:
        userId - (required)
        Returns:
        User

      • expirePasswordAndGetTemporaryPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/expire_password_with_temp_password")
TempPassword expirePasswordAndGetTemporaryPassword​(java.lang.String userId)
        Expire Password and Set Temporary Password This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login, and also sets the user's password to a temporary password returned in the response.
        Parameters:
        userId - (required)
        Returns:
        TempPassword

      • reactivateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
UserActivationToken reactivateUser​(java.lang.String userId,
                                   java.lang.Boolean sendEmail)
        Reactivate User Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user).
        Parameters:
        userId - (required)
        sendEmail - Sends an activation email to the user if true (optional, default to false)
        Returns:
        UserActivationToken

      • reactivateUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/reactivate")
UserActivationToken reactivateUser​(java.lang.String userId)
        Reactivate User Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user).
        Parameters:
        userId - (required)
        Returns:
        UserActivationToken

      • resetFactors

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_factors")
void resetFactors​(java.lang.String userId)
        Reset Factors This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.
        Parameters:
        userId - (required)

      • resetPassword

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/reset_password")
ResetPasswordToken resetPassword​(java.lang.String userId,
                                 java.lang.Boolean sendEmail)
        Reset Password Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.
        Parameters:
        userId - (required)
        sendEmail - (required)
        Returns:
        ResetPasswordToken

      • suspendUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/suspend")
void suspendUser​(java.lang.String userId)
        Suspend User Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete.
        Parameters:
        userId - (required)

      • unlockUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/unlock")
void unlockUser​(java.lang.String userId)
        Unlock User Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password.
        Parameters:
        userId - (required)

      • unsuspendUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/lifecycle/unsuspend")
void unsuspendUser​(java.lang.String userId)
        Unsuspend User Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status.
        Parameters:
        userId - (required)

      • removeLinkedObjectForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
void removeLinkedObjectForUser​(java.lang.String userId,
                               java.lang.String relationshipName)
        Remove Linked Object for User Delete linked objects for a user, relationshipName can be ONLY a primary relationship name
        Parameters:
        userId - (required)
        relationshipName - (required)

      • getLinkedObjectsForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/linkedObjects/{relationshipName}")
ResponseLinksList getLinkedObjectsForUser​(java.lang.String userId,
                                          java.lang.String relationshipName)
        Get Linked Objects for User Get linked objects for a user, relationshipName can be a primary or associated relationship name
        Parameters:
        userId - (required)
        relationshipName - (required)
        Returns:
        ResponseLinksList

      • listAssignedRolesForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/roles")
RoleList listAssignedRolesForUser​(java.lang.String userId,
                                  java.lang.String expand)
        List Assigned Roles for User Lists all roles assigned to a user.
        Parameters:
        userId - (required)
        expand - (optional)
        Returns:
        RoleList

      • listAssignedRolesForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/roles")
RoleList listAssignedRolesForUser​(java.lang.String userId)
        List Assigned Roles for User Lists all roles assigned to a user.
        Parameters:
        userId - (required)
        Returns:
        RoleList

      • assignRoleToUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/roles")
Role assignRoleToUser​(AssignRoleRequest assignRoleRequest,
                      java.lang.String userId,
                      java.lang.Boolean disableNotifications)
        Assign Role to User Assigns a role to a user.
        Parameters:
        assignRoleRequest - (required)
        userId - (required)
        disableNotifications - (optional)
        Returns:
        Role

      • assignRoleToUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/roles")
Role assignRoleToUser​(AssignRoleRequest assignRoleRequest,
                      java.lang.String userId)
        Assign Role to User Assigns a role to a user.
        Parameters:
        assignRoleRequest - (required)
        userId - (required)
        Returns:
        Role

      • removeRoleFromUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}")
void removeRoleFromUser​(java.lang.String userId,
                        java.lang.String roleId)
        Remove Role from User Unassigns a role from a user.
        Parameters:
        userId - (required)
        roleId - (required)

      • getUserRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}")
Role getUserRole​(java.lang.String userId,
                 java.lang.String roleId)
        Get User Role Gets role that is assigned to user.
        Parameters:
        userId - (required)
        roleId - (required)
        Returns:
        Role

      • listApplicationTargetsForApplicationAdministratorRoleForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForUser​(java.lang.String userId,
                                                                                    java.lang.String roleId)
        List Application Targets for Application Administrator Role for User Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.
        Parameters:
        userId - (required)
        roleId - (required)
        Returns:
        CatalogApplicationList

      • addAllAppsAsTargetToRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
void addAllAppsAsTargetToRole​(java.lang.String userId,
                              java.lang.String roleId)
        Add All Apps as Target to Role Success
        Parameters:
        userId - (required)
        roleId - (required)

      • removeApplicationTargetFromApplicationAdministratorRoleForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}")
void removeApplicationTargetFromApplicationAdministratorRoleForUser​(java.lang.String userId,
                                                                    java.lang.String roleId,
                                                                    java.lang.String appName)
        Remove Application Target from Application Administrator Role for User Success
        Parameters:
        userId - (required)
        roleId - (required)
        appName - (required)

      • addApplicationTargetToAdminRoleForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}")
void addApplicationTargetToAdminRoleForUser​(java.lang.String userId,
                                            java.lang.String roleId,
                                            java.lang.String appName)
        Add Application Target to Admin Role for User Success
        Parameters:
        userId - (required)
        roleId - (required)
        appName - (required)

      • removeApplicationTargetFromAdministratorRoleForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
void removeApplicationTargetFromAdministratorRoleForUser​(java.lang.String userId,
                                                         java.lang.String roleId,
                                                         java.lang.String appName,
                                                         java.lang.String applicationId)
        Remove App Instance Target to App Administrator Role given to a User Remove App Instance Target to App Administrator Role given to a User
        Parameters:
        userId - (required)
        roleId - (required)
        appName - (required)
        applicationId - (required)

      • addApplicationTargetToAppAdminRoleForUser

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
void addApplicationTargetToAppAdminRoleForUser​(java.lang.String userId,
                                               java.lang.String roleId,
                                               java.lang.String appName,
                                               java.lang.String applicationId)
        Add App Instance Target to App Administrator Role given to a User Add App Instance Target to App Administrator Role given to a User
        Parameters:
        userId - (required)
        roleId - (required)
        appName - (required)
        applicationId - (required)

      • listGroupTargetsForRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/groups")
GroupList listGroupTargetsForRole​(java.lang.String userId,
                                  java.lang.String roleId)
        List Group Targets for Role Success
        Parameters:
        userId - (required)
        roleId - (required)
        Returns:
        GroupList

      • removeGroupTargetFromRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
void removeGroupTargetFromRole​(java.lang.String userId,
                               java.lang.String roleId,
                               java.lang.String groupId)
        Remove Group Target from Role Success
        Parameters:
        userId - (required)
        roleId - (required)
        groupId - (required)

      • addGroupTargetToRole

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId}")
void addGroupTargetToRole​(java.lang.String userId,
                          java.lang.String roleId,
                          java.lang.String groupId)
        Add Group Target to Role Success
        Parameters:
        userId - (required)
        roleId - (required)
        groupId - (required)

      • clearUserSessions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/sessions")
void clearUserSessions​(java.lang.String userId,
                       java.lang.Boolean oAuthTokens)
        Clear User Sessions Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.
        Parameters:
        userId - (required)
        oAuthTokens - Revoke issued OpenID Connect and OAuth refresh and access tokens (optional, default to false)

      • clearUserSessions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/users/{userId}/sessions")
void clearUserSessions​(java.lang.String userId)
        Clear User Sessions Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.
        Parameters:
        userId - (required)

      • listUserSubscriptions

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/subscriptions")
SubscriptionList listUserSubscriptions​(java.lang.String userId)
        List subscriptions of a User List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.
        Parameters:
        userId - (required)
        Returns:
        SubscriptionList

      • getUserSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/users/{userId}/subscriptions/{notificationType}")
Subscription getUserSubscriptionByNotificationType​(java.lang.String userId,
                                                   java.lang.String notificationType)
        Get the subscription of a User with a specific notification type Get the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.
        Parameters:
        userId - (required)
        notificationType - (required)
        Returns:
        Subscription

      • subscribeUserSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe")
void subscribeUserSubscriptionByNotificationType​(java.lang.String userId,
                                                 java.lang.String notificationType)
        Subscribe to a specific notification type Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.
        Parameters:
        userId - (required)
        notificationType - (required)

      • unsubscribeUserSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeUserSubscriptionByNotificationType​(java.lang.String userId,
                                                   java.lang.String notificationType)
        Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.
        Parameters:
        userId - (required)
        notificationType - (required)

      • listNetworkZones

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/zones")
NetworkZoneList listNetworkZones​(java.lang.String filter)
        List Network Zones Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.
        Parameters:
        filter - Filters zones by usage or id expression (optional)
        Returns:
        NetworkZoneList

      • listNetworkZones

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/zones")
NetworkZoneList listNetworkZones()
        List Network Zones Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.
        Returns:
        NetworkZoneList

      • createNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/zones")
NetworkZone createNetworkZone​(NetworkZone zone)
        Add Network Zone Adds a new network zone to your Okta organization.
        Parameters:
        zone - (required)
        Returns:
        NetworkZone

      • deleteNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="DELETE - /api/v1/zones/{zoneId}")
void deleteNetworkZone​(java.lang.String zoneId)
        Delete Network Zone Removes network zone.
        Parameters:
        zoneId - (required)

      • getNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="GET - /api/v1/zones/{zoneId}")
NetworkZone getNetworkZone​(java.lang.String zoneId)
        Get Network Zone Fetches a network zone from your Okta organization by `id`.
        Parameters:
        zoneId - (required)
        Returns:
        NetworkZone

      • updateNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="PUT - /api/v1/zones/{zoneId}")
NetworkZone updateNetworkZone​(NetworkZone zone,
                              java.lang.String zoneId)
        Update Network Zone Updates a network zone in your organization.
        Parameters:
        zone - (required)
        zoneId - (required)
        Returns:
        NetworkZone

      • activateNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/zones/{zoneId}/lifecycle/activate")
NetworkZone activateNetworkZone​(java.lang.String zoneId)
        Activate Network Zone Activate Network Zone
        Parameters:
        zoneId - (required)
        Returns:
        NetworkZone

      • deactivateNetworkZone

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-23T16:27:00.806818-06:00[America/Chicago]",
           comments="POST - /api/v1/zones/{zoneId}/lifecycle/deactivate")
NetworkZone deactivateNetworkZone​(java.lang.String zoneId)
        Deactivate Network Zone Deactivates a network zone.
        Parameters:
        zoneId - (required)
        Returns:
        NetworkZone