DefaultClient (Okta Java SDK 8.2.3 API)

java.lang.Object
- com.okta.sdk.impl.client.BaseClient
- - com.okta.sdk.impl.client.DefaultClient

All Implemented Interfaces:: Client, DataStore

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00")
public class DefaultClient
extends BaseClient
implements Client

Constructor Summary

Constructors
Constructor and Description
`DefaultClient(ClientConfiguration clientConfiguration, CacheManager cacheManager)` Instantiates a new Client instance that will communicate with the Okta REST API.
`DefaultClient(ClientConfiguration clientConfiguration, CacheManager cacheManager, com.okta.commons.http.RequestExecutor requestExecutor)` Instantiates a new Client instance that will communicate with the Okta REST API.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TrustedOrigin`	`activateOrigin(String trustedOriginId)` Success
`LinkedObject`	`addLinkedObjectDefinition(LinkedObject linkedObject)` Success
`JsonWebKey`	`apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost(String idpId, String csrId)` Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.
`Application`	`createApplication(Application application)` Add Application Adds a new application to your Okta organization.
`Application`	`createApplication(Application application, Boolean activate, String oktaAccessGatewayAgent)` Add Application Adds a new application to your Okta organization.
`AuthorizationServer`	`createAuthorizationServer(AuthorizationServer authorizationServer)` Success
`Domain`	`createDomain(Domain domain)` Create Domain Creates your domain.
`EventHook`	`createEventHook(EventHook eventHook)` Success
`Group`	`createGroup(Group group)` Add Group Adds a new group with `OKTA_GROUP` type to your organization.
`GroupRule`	`createGroupRule(GroupRule groupRule)` Create Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition
`IdentityProvider`	`createIdentityProvider(IdentityProvider identityProvider)` Add Identity Provider Adds a new IdP to your organization.
`JsonWebKey`	`createIdentityProviderKey(JsonWebKey jsonWebKey)` Add X.509 Certificate Public Key Adds a new X.509 certificate credential to the IdP key store.
`InlineHook`	`createInlineHook(InlineHook inlineHook)` Success
`NetworkZone`	`createNetworkZone(NetworkZone zone)` Add Network Zone Adds a new network zone to your Okta organization.
`TrustedOrigin`	`createOrigin(TrustedOrigin trustedOrigin)` Success
`Policy`	`createPolicy(Policy policy)` Creates a policy.
`Policy`	`createPolicy(Policy policy, Boolean activate)` Creates a policy.
`Session`	`createSession(CreateSessionRequest createSessionRequest)` Create Session with Session Token Creates a new session for a user with a valid session token.
`SmsTemplate`	`createSmsTemplate(SmsTemplate smsTemplate)` Add SMS Template Adds a new custom SMS template to your organization.
`User`	`createUser(CreateUserRequest body)` Create User Creates a new user in your Okta organization with or without credentials.
`User`	`createUser(CreateUserRequest body, Boolean activate, Boolean provider, UserNextLogin nextLogin)` Create User Creates a new user in your Okta organization with or without credentials.
`UserType`	`createUserType(UserType userType)` Creates a new User Type.
`TrustedOrigin`	`deactivateOrigin(String trustedOriginId)` Success
`void`	`deleteDomain(String domainId)` Delete Domain Deletes a Domain by `id`.
`void`	`deleteIdentityProviderKey(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.
`Application`	`getApplication(String appId)` Get Application Fetches an application from your Okta organization by `id`.
`Application`	`getApplication(String appId, String expand)` Get Application Fetches an application from your Okta organization by `id`.
`UserSchema`	`getApplicationUserSchema(String appInstanceId)` Fetches the Schema for an App User Fetches the Schema for an App User
`Authenticator`	`getAuthenticator(String authenticatorId)` Success
`AuthorizationServer`	`getAuthorizationServer(String authServerId)` Success
`Brand`	`getBrand(String brandId)` Get Brand Fetches a brand by `brandId`
`ThemeResponse`	`getBrandTheme(String brandId, String themeId)` Get a theme for a brand Fetches a theme for a brand
`ThreatInsightConfiguration`	`getCurrentConfiguration()` Gets current ThreatInsight configuration
`Domain`	`getDomain(String domainId)` Get Domain Fetches a Domain by `id`.
`EventHook`	`getEventHook(String eventHookId)` Success
`VerifyUserFactorResponse`	`getFactorTransactionStatus(String userId, String factorId, String transactionId)` Polls factors verification transaction for status.
`Feature`	`getFeature(String featureId)` Success
`Group`	`getGroup(String groupId)` List Group Rules Fetches a group from your organization.
`GroupRule`	`getGroupRule(String ruleId)` Get Group Rule Fetches a specific group rule by id from your organization
`GroupRule`	`getGroupRule(String ruleId, String expand)` Get Group Rule Fetches a specific group rule by id from your organization
`GroupSchema`	`getGroupSchema()` Fetches the group schema Fetches the group schema
`IdentityProvider`	`getIdentityProvider(String idpId)` Get Identity Provider Fetches an IdP by `id`.
`JsonWebKey`	`getIdentityProviderKey(String keyId)` Get Key Gets a specific IdP Key Credential by `kid`
`InlineHook`	`getInlineHook(String inlineHookId)` Gets an inline hook by ID
`LinkedObject`	`getLinkedObjectDefinition(String linkedObjectName)` Success
`LogEventList`	`getLogs()` Fetch a list of events from your Okta organization system log.
`LogEventList`	`getLogs(Date since, Date until, String filter, String q, String sortOrder)` Fetch a list of events from your Okta organization system log.
`NetworkZone`	`getNetworkZone(String zoneId)` Get Network Zone Fetches a network zone from your Okta organization by `id`.
`OrgSetting`	`getOrgSettings()` Get org settings Get settings of your organization.
`TrustedOrigin`	`getOrigin(String trustedOriginId)` Success
`Policy`	`getPolicy(String policyId)` Gets a policy.
`Policy`	`getPolicy(String policyId, String expand)` Gets a policy.
`ProfileMapping`	`getProfileMapping(String mappingId)` Get Profile Mapping Fetches a single Profile Mapping referenced by its ID.
`Role`	`getRole(String groupId, String roleId)` Success
`Session`	`getSession(String sessionId)` Get details about a session.
`SmsTemplate`	`getSmsTemplate(String templateId)` Get SMS Template Fetches a specific template by `id`
`User`	`getUser(String userId)` Get User Fetches a user from your Okta organization.
`OAuth2ScopeConsentGrant`	`getUserGrant(String userId, String grantId)` Gets a grant for the specified user
`OAuth2ScopeConsentGrant`	`getUserGrant(String userId, String grantId, String expand)` Gets a grant for the specified user
`UserSchema`	`getUserSchema(String schemaId)` Fetches the schema for a Schema Id.
`UserType`	`getUserType(String typeId)` Fetches a User Type by ID.
`ApplicationList`	`listApplications()` List Applications Enumerates apps added to your organization with pagination.
`ApplicationList`	`listApplications(String q, String filter, String expand, Boolean includeNonDeleted)` List Applications Enumerates apps added to your organization with pagination.
`CatalogApplicationList`	`listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId, String roleId)` Lists all App targets for an `APP_ADMIN` Role assigned to a Group.
`CatalogApplicationList`	`listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleId)` Lists all App targets for an `APP_ADMIN` Role assigned to a User.
`AuthenticatorList`	`listAuthenticators()` Success
`AuthorizationServerList`	`listAuthorizationServers()` Success
`AuthorizationServerList`	`listAuthorizationServers(String q)` Success
`BrandList`	`listBrands()` List Brands List all the brands in your org.
`ThemeResponseList`	`listBrandThemes(String brandId)` Get Brand Themes List all the themes in your brand
`DomainListResponse`	`listDomains()` List Domains List all verified custom Domains for the org.
`EmailTemplateList`	`listEmailTemplates(String brandId)` List Email Templates List email templates in your organization with pagination.
`EventHookList`	`listEventHooks()` Success
`FeatureList`	`listFeatures()` Success
`OAuth2ScopeConsentGrantList`	`listGrantsForUserAndClient(String userId, String clientId)` Lists all grants for a specified user and client
`OAuth2ScopeConsentGrantList`	`listGrantsForUserAndClient(String userId, String clientId, String expand)` Lists all grants for a specified user and client
`RoleList`	`listGroupAssignedRoles(String groupId)` Success
`RoleList`	`listGroupAssignedRoles(String groupId, String expand)` Success
`GroupRuleList`	`listGroupRules()` List Group Rules Lists all group rules for your organization.
`GroupRuleList`	`listGroupRules(String search, String expand)` List Group Rules Lists all group rules for your organization.
`GroupList`	`listGroups()` List Groups Enumerates groups in your organization with pagination.
`GroupList`	`listGroups(String q, String search, String expand)` List Groups Enumerates groups in your organization with pagination.
`GroupList`	`listGroupTargetsForGroupRole(String groupId, String roleId)` Success
`JsonWebKeyList`	`listIdentityProviderKeys()` List Keys Enumerates IdP key credentials.
`IdentityProviderList`	`listIdentityProviders()` List Identity Providers Enumerates IdPs in your organization with pagination.
`IdentityProviderList`	`listIdentityProviders(String q, String type)` List Identity Providers Enumerates IdPs in your organization with pagination.
`InlineHookList`	`listInlineHooks()` Success
`InlineHookList`	`listInlineHooks(String type)` Success
`LinkedObjectList`	`listLinkedObjectDefinitions()` Success
`NetworkZoneList`	`listNetworkZones()` List Network Zones Enumerates network zones added to your organization with pagination.
`NetworkZoneList`	`listNetworkZones(String filter)` List Network Zones Enumerates network zones added to your organization with pagination.
`TrustedOriginList`	`listOrigins()` Success
`TrustedOriginList`	`listOrigins(String q, String filter)` Success
`PolicyList`	`listPolicies(String type)` Gets all policies with the specified type.
`PolicyList`	`listPolicies(String type, String status, String expand)` Gets all policies with the specified type.
`ProfileMappingList`	`listProfileMappings()` Enumerates Profile Mappings in your organization with pagination.
`ProfileMappingList`	`listProfileMappings(String sourceId, String targetId)` Enumerates Profile Mappings in your organization with pagination.
`SmsTemplateList`	`listSmsTemplates()` List SMS Templates Enumerates custom SMS templates in your organization.
`SmsTemplateList`	`listSmsTemplates(SmsTemplateType templateType)` List SMS Templates Enumerates custom SMS templates in your organization.
`UserList`	`listUsers()` List Users Lists users in your organization with pagination in most cases.
`UserList`	`listUsers(String q, String filter, String search, String sortBy, String sortOrder)` List Users Lists users in your organization with pagination in most cases.
`UserTypeList`	`listUserTypes()` Fetches all User Types in your org
`User`	`partialUpdateUser(User user, String userId)` Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.
`User`	`partialUpdateUser(User user, String userId, Boolean strict)` Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.
`void`	`removeApplicationTargetFromAdministratorRoleForUser(String userId, String roleId, String appName, 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
`void`	`removeApplicationTargetFromAdministratorRoleGivenToGroup(String groupId, String roleId, String appName, 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
`void`	`removeApplicationTargetFromApplicationAdministratorRoleForUser(String userId, String roleId, String appName)` Success
`void`	`removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup(String groupId, String roleId, String appName)` Success
`void`	`removeGroupTargetFromGroupAdministratorRoleGivenToGroup(String groupId, String roleId, String targetGroupId)`
`void`	`removeRoleFromGroup(String groupId, String roleId)` Unassigns a Role from a Group
`UserSchema`	`updateApplicationUserProfile(String appInstanceId)` Partial updates on the User Profile properties of the Application User Schema.
`UserSchema`	`updateApplicationUserProfile(String appInstanceId, UserSchema body)` Partial updates on the User Profile properties of the Application User Schema.
`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
`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
`UserSchema`	`updateUserProfile(String schemaId, UserSchema userSchema)` Partial updates on the User Profile properties of the user schema.
`Domain`	`verifyDomain(String domainId)` Verify Domain Verifies the Domain by `id`.

Methods inherited from class com.okta.sdk.impl.client.BaseClient
create, createDataStore, createRequestExecutor, delete, getCacheManager, getClientCredentials, getDataStore, getResource, http, instantiate, isReady, save

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.okta.sdk.client.Client
getDataStore

Methods inherited from interface com.okta.sdk.ds.DataStore
create, delete, getCacheManager, getClientCredentials, getResource, http, instantiate, isReady, save

Constructor Detail
- DefaultClient
```
public DefaultClient(ClientConfiguration clientConfiguration,
                     CacheManager cacheManager)
```
  Instantiates a new Client instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.
  
  Parameters:
  
  clientConfiguration - the ClientConfiguration containing the connection information
  
  cacheManager - the CacheManager that should be used to cache
- DefaultClient
```
public DefaultClient(ClientConfiguration clientConfiguration,
                     CacheManager cacheManager,
                     com.okta.commons.http.RequestExecutor requestExecutor)
```
  Instantiates a new Client instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.
  
  Parameters:
  
  clientConfiguration - the ClientConfiguration containing the connection information
  
  cacheManager - the CacheManager that should be used to cache
  
  requestExecutor - the RequestExecutor that should be used to execute requests

Method Detail

listApplications

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/apps")
public ApplicationList listApplications(String q,
                                                                                                                                                                                                          String filter,
                                                                                                                                                                                                          String expand,
                                                                                                                                                                                                          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.

Specified by:: listApplications in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/apps")
public 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.

Specified by:

listApplications in interface Client

Returns:

ApplicationList

createApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/apps")
public Application createApplication(Application application,
                                                                                                                                                                                                        Boolean activate,
                                                                                                                                                                                                        String oktaAccessGatewayAgent)

Add Application Adds a new application to your Okta organization.

Specified by:: createApplication in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/apps")
public Application createApplication(Application application)

Add Application Adds a new application to your Okta organization.

Specified by:: createApplication in interface Client
Parameters:: application - (required)
Returns:: Application

getApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/apps/{appId}")
public Application getApplication(String appId,
                                                                                                                                                                                                            String expand)

Get Application Fetches an application from your Okta organization by `id`.

Specified by:: getApplication in interface Client
Parameters:: appId - (required); expand - (optional)
Returns:: Application

getApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/apps/{appId}")
public Application getApplication(String appId)

Get Application Fetches an application from your Okta organization by `id`.

Specified by:: getApplication in interface Client
Parameters:: appId - (required)
Returns:: Application

listAuthenticators

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/authenticators")
public AuthenticatorList listAuthenticators()

Success

Specified by:: listAuthenticators in interface Client
Returns:: AuthenticatorList

getAuthenticator

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/authenticators/{authenticatorId}")
public Authenticator getAuthenticator(String authenticatorId)

Success

Specified by:: getAuthenticator in interface Client
Parameters:: authenticatorId - (required)
Returns:: Authenticator

listAuthorizationServers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/authorizationServers")
public AuthorizationServerList listAuthorizationServers(String q)

Success

Specified by:: listAuthorizationServers in interface Client
Parameters:: q - (optional)
Returns:: AuthorizationServerList

listAuthorizationServers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/authorizationServers")
public AuthorizationServerList listAuthorizationServers()

Success

Specified by:: listAuthorizationServers in interface Client
Returns:: AuthorizationServerList

createAuthorizationServer

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/authorizationServers")
public AuthorizationServer createAuthorizationServer(AuthorizationServer authorizationServer)

Success

Specified by:: createAuthorizationServer in interface Client
Parameters:: authorizationServer - (required)
Returns:: AuthorizationServer

getAuthorizationServer

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}")
public AuthorizationServer getAuthorizationServer(String authServerId)

Success

Specified by:: getAuthorizationServer in interface Client
Parameters:: authServerId - (required)
Returns:: AuthorizationServer

listBrands

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands")
public BrandList listBrands()

List Brands List all the brands in your org.

Specified by:: listBrands in interface Client
Returns:: BrandList

getBrand

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}")
public Brand getBrand(String brandId)

Get Brand Fetches a brand by `brandId`

Specified by:: getBrand in interface Client
Parameters:: brandId - (required)
Returns:: Brand

listEmailTemplates

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email")
public EmailTemplateList listEmailTemplates(String brandId)

List Email Templates List email templates in your organization with pagination.

Specified by:: listEmailTemplates in interface Client
Parameters:: brandId - (required)
Returns:: EmailTemplateList

listBrandThemes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/themes")
public ThemeResponseList listBrandThemes(String brandId)

Get Brand Themes List all the themes in your brand

Specified by:: listBrandThemes in interface Client
Parameters:: brandId - (required)
Returns:: ThemeResponseList

getBrandTheme

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/brands/{brandId}/themes/{themeId}")
public ThemeResponse getBrandTheme(String brandId,
                                                                                                                                                                                                                                  String themeId)

Get a theme for a brand Fetches a theme for a brand

Specified by:: getBrandTheme in interface Client
Parameters:: brandId - (required); themeId - (required)
Returns:: ThemeResponse

listDomains

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/domains")
public DomainListResponse listDomains()

List Domains List all verified custom Domains for the org.

Specified by:: listDomains in interface Client
Returns:: DomainListResponse

createDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/domains")
public Domain createDomain(Domain domain)

Create Domain Creates your domain.

Specified by:: createDomain in interface Client
Parameters:: domain - (required)
Returns:: Domain

deleteDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/domains/{domainId}")
public void deleteDomain(String domainId)

Delete Domain Deletes a Domain by `id`.

Specified by:: deleteDomain in interface Client
Parameters:: domainId - (required)

getDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/domains/{domainId}")
public Domain getDomain(String domainId)

Get Domain Fetches a Domain by `id`.

Specified by:: getDomain in interface Client
Parameters:: domainId - (required)
Returns:: Domain

verifyDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/domains/{domainId}/verify")
public Domain verifyDomain(String domainId)

Verify Domain Verifies the Domain by `id`.

Specified by:: verifyDomain in interface Client
Parameters:: domainId - (required)
Returns:: Domain

listEventHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/eventHooks")
public EventHookList listEventHooks()

Success

Specified by:: listEventHooks in interface Client
Returns:: EventHookList

createEventHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/eventHooks")
public EventHook createEventHook(EventHook eventHook)

Success

Specified by:: createEventHook in interface Client
Parameters:: eventHook - (required)
Returns:: EventHook

getEventHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/eventHooks/{eventHookId}")
public EventHook getEventHook(String eventHookId)

Success

Specified by:: getEventHook in interface Client
Parameters:: eventHookId - (required)
Returns:: EventHook

listFeatures

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/features")
public FeatureList listFeatures()

Success

Specified by:: listFeatures in interface Client
Returns:: FeatureList

getFeature

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/features/{featureId}")
public Feature getFeature(String featureId)

Success

Specified by:: getFeature in interface Client
Parameters:: featureId - (required)
Returns:: Feature

listGroups

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups")
public GroupList listGroups(String q,
                                                                                                                                                                                                String search,
                                                                                                                                                                                                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.

Specified by:: listGroups in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups")
public 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.

Specified by:: listGroups in interface Client
Returns:: GroupList

createGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/groups")
public Group createGroup(Group group)

Add Group Adds a new group with `OKTA_GROUP` type to your organization.

Specified by:: createGroup in interface Client
Parameters:: group - (required)
Returns:: Group

listGroupRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/rules")
public GroupRuleList listGroupRules(String search,
                                                                                                                                                                                                              String expand)

List Group Rules Lists all group rules for your organization.

Specified by:: listGroupRules in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/rules")
public GroupRuleList listGroupRules()

List Group Rules Lists all group rules for your organization.

Specified by:: listGroupRules in interface Client
Returns:: GroupRuleList

createGroupRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/groups/rules")
public GroupRule createGroupRule(GroupRule groupRule)

Create Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition

Specified by:: createGroupRule in interface Client
Parameters:: groupRule - (required)
Returns:: GroupRule

getGroupRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/rules/{ruleId}")
public GroupRule getGroupRule(String ruleId,
                                                                                                                                                                                                                 String expand)

Get Group Rule Fetches a specific group rule by id from your organization

Specified by:: getGroupRule in interface Client
Parameters:: ruleId - (required); expand - (optional)
Returns:: GroupRule

getGroupRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/rules/{ruleId}")
public GroupRule getGroupRule(String ruleId)

Get Group Rule Fetches a specific group rule by id from your organization

Specified by:: getGroupRule in interface Client
Parameters:: ruleId - (required)
Returns:: GroupRule

getGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}")
public Group getGroup(String groupId)

List Group Rules Fetches a group from your organization.

Specified by:: getGroup in interface Client
Parameters:: groupId - (required)
Returns:: Group

listGroupAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}/roles")
public RoleList listGroupAssignedRoles(String groupId,
                                                                                                                                                                                                                           String expand)

Success

Specified by:: listGroupAssignedRoles in interface Client
Parameters:: groupId - (required); expand - (optional)
Returns:: RoleList

listGroupAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}/roles")
public RoleList listGroupAssignedRoles(String groupId)

Success

Specified by:: listGroupAssignedRoles in interface Client
Parameters:: groupId - (required)
Returns:: RoleList

removeRoleFromGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}")
public void removeRoleFromGroup(String groupId,
                                                                                                                                                                                                                                String roleId)

Unassigns a Role from a Group

Specified by:: removeRoleFromGroup in interface Client
Parameters:: groupId - (required); roleId - (required)

getRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}")
public Role getRole(String groupId,
                                                                                                                                                                                                                 String roleId)

Success

Specified by:: getRole in interface Client
Parameters:: groupId - (required); roleId - (required)
Returns:: Role

listApplicationTargetsForApplicationAdministratorRoleForGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps")
public CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId,
                                                                                                                                                                                                                                                                                                              String roleId)

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.

Specified by:: listApplicationTargetsForApplicationAdministratorRoleForGroup in interface Client
Parameters:: groupId - (required); roleId - (required)
Returns:: CatalogApplicationList

removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}")
public void removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup(String groupId,
                                                                                                                                                                                                                                                                                                               String roleId,
                                                                                                                                                                                                                                                                                                               String appName)

Success

Specified by:: removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup in interface Client
Parameters:: groupId - (required); roleId - (required); appName - (required)

removeApplicationTargetFromAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
public void removeApplicationTargetFromAdministratorRoleGivenToGroup(String groupId,
                                                                                                                                                                                                                                                                                                                    String roleId,
                                                                                                                                                                                                                                                                                                                    String appName,
                                                                                                                                                                                                                                                                                                                    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

Specified by:: removeApplicationTargetFromAdministratorRoleGivenToGroup in interface Client
Parameters:: groupId - (required); roleId - (required); appName - (required); applicationId - (required)

listGroupTargetsForGroupRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups")
public GroupList listGroupTargetsForGroupRole(String groupId,
                                                                                                                                                                                                                                                          String roleId)

Success

Specified by:: listGroupTargetsForGroupRole in interface Client
Parameters:: groupId - (required); roleId - (required)
Returns:: GroupList

removeGroupTargetFromGroupAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}")
public void removeGroupTargetFromGroupAdministratorRoleGivenToGroup(String groupId,
                                                                                                                                                                                                                                                                                                   String roleId,
                                                                                                                                                                                                                                                                                                   String targetGroupId)

Specified by:: removeGroupTargetFromGroupAdministratorRoleGivenToGroup in interface Client
Parameters:: groupId - (required); roleId - (required); targetGroupId - (required)

listIdentityProviders

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/idps")
public IdentityProviderList listIdentityProviders(String q,
                                                                                                                                                                                                                    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.

Specified by:: listIdentityProviders in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/idps")
public 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.

Specified by:

listIdentityProviders in interface Client

Returns:

IdentityProviderList

createIdentityProvider

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/idps")
public IdentityProvider createIdentityProvider(IdentityProvider identityProvider)

Add Identity Provider Adds a new IdP to your organization.

Specified by:: createIdentityProvider in interface Client
Parameters:: identityProvider - (required)
Returns:: IdentityProvider

listIdentityProviderKeys

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/idps/credentials/keys")
public JsonWebKeyList listIdentityProviderKeys()

List Keys Enumerates IdP key credentials.

Specified by:: listIdentityProviderKeys in interface Client
Returns:: JsonWebKeyList

createIdentityProviderKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/idps/credentials/keys")
public JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey)

Add X.509 Certificate Public Key Adds a new X.509 certificate credential to the IdP key store.

Specified by:: createIdentityProviderKey in interface Client
Parameters:: jsonWebKey - (required)
Returns:: JsonWebKey

deleteIdentityProviderKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/idps/credentials/keys/{keyId}")
public void deleteIdentityProviderKey(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.

Specified by:: deleteIdentityProviderKey in interface Client
Parameters:: keyId - (required)

getIdentityProviderKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/idps/credentials/keys/{keyId}")
public JsonWebKey getIdentityProviderKey(String keyId)

Get Key Gets a specific IdP Key Credential by `kid`

Specified by:: getIdentityProviderKey in interface Client
Parameters:: keyId - (required)
Returns:: JsonWebKey

getIdentityProvider

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/idps/{idpId}")
public IdentityProvider getIdentityProvider(String idpId)

Get Identity Provider Fetches an IdP by `id`.

Specified by:: getIdentityProvider in interface Client
Parameters:: idpId - (required)
Returns:: IdentityProvider

apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish")
public JsonWebKey apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost(String idpId,
                                                                                                                                                                                                                                                                                               String csrId)

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

Specified by:: apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost in interface Client
Parameters:: idpId - (required); csrId - (required)
Returns:: JsonWebKey

listInlineHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/inlineHooks")
public InlineHookList listInlineHooks(String type)

Success

Specified by:: listInlineHooks in interface Client
Parameters:: type - (optional)
Returns:: InlineHookList

listInlineHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/inlineHooks")
public InlineHookList listInlineHooks()

Success

Specified by:: listInlineHooks in interface Client
Returns:: InlineHookList

createInlineHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/inlineHooks")
public InlineHook createInlineHook(InlineHook inlineHook)

Success

Specified by:: createInlineHook in interface Client
Parameters:: inlineHook - (required)
Returns:: InlineHook

getInlineHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/inlineHooks/{inlineHookId}")
public InlineHook getInlineHook(String inlineHookId)

Gets an inline hook by ID

Specified by:: getInlineHook in interface Client
Parameters:: inlineHookId - (required)
Returns:: InlineHook

getLogs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/logs")
public LogEventList getLogs(Date since,
                                                                                                                                                                                              Date until,
                                                                                                                                                                                              String filter,
                                                                                                                                                                                              String q,
                                                                                                                                                                                              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

Specified by:: getLogs in interface Client
Parameters:: since - (optional); until - (optional); filter - (optional); q - (optional); sortOrder - (optional, default to ASCENDING)
Returns:: LogEventList

getLogs
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/logs")
public 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

Specified by:

getLogs in interface Client

Returns:

LogEventList

listProfileMappings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/mappings")
public ProfileMappingList listProfileMappings(String sourceId,
                                                                                                                                                                                                                    String targetId)

Enumerates Profile Mappings in your organization with pagination.

Specified by:: listProfileMappings in interface Client
Parameters:: sourceId - (optional); targetId - (optional, default to )
Returns:: ProfileMappingList

listProfileMappings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/mappings")
public ProfileMappingList listProfileMappings()

Enumerates Profile Mappings in your organization with pagination.

Specified by:: listProfileMappings in interface Client
Returns:: ProfileMappingList

getProfileMapping

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/mappings/{mappingId}")
public ProfileMapping getProfileMapping(String mappingId)

Get Profile Mapping Fetches a single Profile Mapping referenced by its ID.

Specified by:: getProfileMapping in interface Client
Parameters:: mappingId - (required)
Returns:: ProfileMapping

getApplicationUserSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/schemas/apps/{appInstanceId}/default")
public UserSchema getApplicationUserSchema(String appInstanceId)

Fetches the Schema for an App User Fetches the Schema for an App User

Specified by:: getApplicationUserSchema in interface Client
Parameters:: appInstanceId - (required)
Returns:: UserSchema

updateApplicationUserProfile

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
public UserSchema updateApplicationUserProfile(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.

Specified by:: updateApplicationUserProfile in interface Client
Parameters:: appInstanceId - (required); body - (optional)
Returns:: UserSchema

updateApplicationUserProfile

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
public UserSchema updateApplicationUserProfile(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.

Specified by:: updateApplicationUserProfile in interface Client
Parameters:: appInstanceId - (required)
Returns:: UserSchema

getGroupSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/schemas/group/default")
public GroupSchema getGroupSchema()

Fetches the group schema Fetches the group schema

Specified by:: getGroupSchema in interface Client
Returns:: GroupSchema

updateGroupSchema
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/group/default")
public 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

Specified by:

updateGroupSchema in interface Client

Parameters:

body - (optional)

Returns:

GroupSchema

updateGroupSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/group/default")
public 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

Specified by:: updateGroupSchema in interface Client
Returns:: GroupSchema

listLinkedObjectDefinitions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects")
public LinkedObjectList listLinkedObjectDefinitions()

Success

Specified by:: listLinkedObjectDefinitions in interface Client
Returns:: LinkedObjectList

addLinkedObjectDefinition

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/user/linkedObjects")
public LinkedObject addLinkedObjectDefinition(LinkedObject linkedObject)

Success

Specified by:: addLinkedObjectDefinition in interface Client
Parameters:: linkedObject - (required)
Returns:: LinkedObject

getLinkedObjectDefinition

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}")
public LinkedObject getLinkedObjectDefinition(String linkedObjectName)

Success

Specified by:: getLinkedObjectDefinition in interface Client
Parameters:: linkedObjectName - (required)
Returns:: LinkedObject

getUserSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/schemas/user/{schemaId}")
public UserSchema getUserSchema(String schemaId)

Fetches the schema for a Schema Id. Fetches the schema for a Schema Id.

Specified by:: getUserSchema in interface Client
Parameters:: schemaId - (required)
Returns:: UserSchema

updateUserProfile

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/schemas/user/{schemaId}")
public UserSchema updateUserProfile(String schemaId,
                                                                                                                                                                                                                               UserSchema userSchema)

Partial updates on the User Profile properties of the user schema.

Specified by:: updateUserProfile in interface Client
Parameters:: schemaId - (required); userSchema - (required)
Returns:: UserSchema

listUserTypes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/types/user")
public UserTypeList listUserTypes()

Fetches all User Types in your org

Specified by:: listUserTypes in interface Client
Returns:: UserTypeList

createUserType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/meta/types/user")
public UserType createUserType(UserType userType)

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.

Specified by:: createUserType in interface Client
Parameters:: userType - (required)
Returns:: UserType

getUserType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/meta/types/user/{typeId}")
public UserType getUserType(String typeId)

Fetches a User Type by ID. The special identifier `default` may be used to fetch the default User Type.

Specified by:: getUserType in interface Client
Parameters:: typeId - (required)
Returns:: UserType

getOrgSettings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/org")
public OrgSetting getOrgSettings()

Get org settings Get settings of your organization.

Specified by:: getOrgSettings in interface Client
Returns:: OrgSetting

listPolicies

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/policies")
public PolicyList listPolicies(String type,
                                                                                                                                                                                                     String status,
                                                                                                                                                                                                     String expand)

Gets all policies with the specified type.

Specified by:: listPolicies in interface Client
Parameters:: type - (required); status - (optional); expand - (optional, default to )
Returns:: PolicyList

listPolicies

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/policies")
public PolicyList listPolicies(String type)

Gets all policies with the specified type.

Specified by:: listPolicies in interface Client
Parameters:: type - (required)
Returns:: PolicyList

createPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/policies")
public Policy createPolicy(Policy policy,
                                                                                                                                                                                                  Boolean activate)

Creates a policy.

Specified by:: createPolicy in interface Client
Parameters:: policy - (required); activate - (optional, default to true)
Returns:: Policy

createPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/policies")
public Policy createPolicy(Policy policy)

Creates a policy.

Specified by:: createPolicy in interface Client
Parameters:: policy - (required)
Returns:: Policy

getPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/policies/{policyId}")
public Policy getPolicy(String policyId,
                                                                                                                                                                                                         String expand)

Gets a policy.

Specified by:: getPolicy in interface Client
Parameters:: policyId - (required); expand - (optional, default to )
Returns:: Policy

getPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/policies/{policyId}")
public Policy getPolicy(String policyId)

Gets a policy.

Specified by:: getPolicy in interface Client
Parameters:: policyId - (required)
Returns:: Policy

createSession
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/sessions")
public 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.

Specified by:

createSession in interface Client

Parameters:

createSessionRequest - (required)

Returns:

Session

getSession

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/sessions/{sessionId}")
public Session getSession(String sessionId)

Get details about a session.

Specified by:: getSession in interface Client
Parameters:: sessionId - (required)
Returns:: Session

listSmsTemplates

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/templates/sms")
public 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.

Specified by:: listSmsTemplates in interface Client
Parameters:: templateType - (optional)
Returns:: SmsTemplateList

listSmsTemplates

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/templates/sms")
public SmsTemplateList listSmsTemplates()

List SMS Templates Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.

Specified by:: listSmsTemplates in interface Client
Returns:: SmsTemplateList

createSmsTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/templates/sms")
public SmsTemplate createSmsTemplate(SmsTemplate smsTemplate)

Add SMS Template Adds a new custom SMS template to your organization.

Specified by:: createSmsTemplate in interface Client
Parameters:: smsTemplate - (required)
Returns:: SmsTemplate

getSmsTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/templates/sms/{templateId}")
public SmsTemplate getSmsTemplate(String templateId)

Get SMS Template Fetches a specific template by `id`

Specified by:: getSmsTemplate in interface Client
Parameters:: templateId - (required)
Returns:: SmsTemplate

getCurrentConfiguration

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/threats/configuration")
public ThreatInsightConfiguration getCurrentConfiguration()

Gets current ThreatInsight configuration

Specified by:: getCurrentConfiguration in interface Client
Returns:: ThreatInsightConfiguration

listOrigins

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/trustedOrigins")
public TrustedOriginList listOrigins(String q,
                                                                                                                                                                                                                 String filter)

Success

Specified by:: listOrigins in interface Client
Parameters:: q - (optional); filter - (optional)
Returns:: TrustedOriginList

listOrigins

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/trustedOrigins")
public TrustedOriginList listOrigins()

Success

Specified by:: listOrigins in interface Client
Returns:: TrustedOriginList

createOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/trustedOrigins")
public TrustedOrigin createOrigin(TrustedOrigin trustedOrigin)

Success

Specified by:: createOrigin in interface Client
Parameters:: trustedOrigin - (required)
Returns:: TrustedOrigin

getOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/trustedOrigins/{trustedOriginId}")
public TrustedOrigin getOrigin(String trustedOriginId)

Success

Specified by:: getOrigin in interface Client
Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

activateOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate")
public TrustedOrigin activateOrigin(String trustedOriginId)

Success

Specified by:: activateOrigin in interface Client
Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

deactivateOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate")
public TrustedOrigin deactivateOrigin(String trustedOriginId)

Success

Specified by:: deactivateOrigin in interface Client
Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users")
public UserList listUsers(String q,
                                                                                                                                                                                             String filter,
                                                                                                                                                                                             String search,
                                                                                                                                                                                             String sortBy,
                                                                                                                                                                                             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.

Specified by:: listUsers in interface Client
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.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users")
public 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.

Specified by:

listUsers in interface Client

Returns:

UserList

createUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/users")
public User createUser(CreateUserRequest body,
                                                                                                                                                                                           Boolean activate,
                                                                                                                                                                                           Boolean provider,
                                                                                                                                                                                           UserNextLogin nextLogin)

Create User Creates a new user in your Okta organization with or without credentials.

Specified by:: createUser in interface Client
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, default to )
Returns:: User

createUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/users")
public User createUser(CreateUserRequest body)

Create User Creates a new user in your Okta organization with or without credentials.

Specified by:: createUser in interface Client
Parameters:: body - (required)
Returns:: User

getUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}")
public User getUser(String userId)

Get User Fetches a user from your Okta organization.

Specified by:: getUser in interface Client
Parameters:: userId - (required)
Returns:: User

partialUpdateUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/users/{userId}")
public User partialUpdateUser(User user,
                                                                                                                                                                                                           String userId,
                                                                                                                                                                                                           Boolean strict)

Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.

Specified by:: partialUpdateUser in interface Client
Parameters:: user - (required); userId - (required); strict - (optional)
Returns:: User

partialUpdateUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/users/{userId}")
public User partialUpdateUser(User user,
                                                                                                                                                                                                           String userId)

Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.

Specified by:: partialUpdateUser in interface Client
Parameters:: user - (required); userId - (required)
Returns:: User

listGrantsForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
public OAuth2ScopeConsentGrantList listGrantsForUserAndClient(String userId,
                                                                                                                                                                                                                                                                    String clientId,
                                                                                                                                                                                                                                                                    String expand)

Lists all grants for a specified user and client

Specified by:: listGrantsForUserAndClient in interface Client
Parameters:: userId - (required); clientId - (required); expand - (optional)
Returns:: OAuth2ScopeConsentGrantList

listGrantsForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
public OAuth2ScopeConsentGrantList listGrantsForUserAndClient(String userId,
                                                                                                                                                                                                                                                                    String clientId)

Lists all grants for a specified user and client

Specified by:: listGrantsForUserAndClient in interface Client
Parameters:: userId - (required); clientId - (required)
Returns:: OAuth2ScopeConsentGrantList

getFactorTransactionStatus

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}")
public VerifyUserFactorResponse getFactorTransactionStatus(String userId,
                                                                                                                                                                                                                                                                                       String factorId,
                                                                                                                                                                                                                                                                                       String transactionId)

Polls factors verification transaction for status.

Specified by:: getFactorTransactionStatus in interface Client
Parameters:: userId - (required); factorId - (required); transactionId - (required)
Returns:: VerifyUserFactorResponse

getUserGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
public OAuth2ScopeConsentGrant getUserGrant(String userId,
                                                                                                                                                                                                                                         String grantId,
                                                                                                                                                                                                                                         String expand)

Gets a grant for the specified user

Specified by:: getUserGrant in interface Client
Parameters:: userId - (required); grantId - (required); expand - (optional)
Returns:: OAuth2ScopeConsentGrant

getUserGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
public OAuth2ScopeConsentGrant getUserGrant(String userId,
                                                                                                                                                                                                                                         String grantId)

Gets a grant for the specified user

Specified by:: getUserGrant in interface Client
Parameters:: userId - (required); grantId - (required)
Returns:: OAuth2ScopeConsentGrant

listApplicationTargetsForApplicationAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
public CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForUser(String userId,
                                                                                                                                                                                                                                                                                                           String roleId)

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.

Specified by:: listApplicationTargetsForApplicationAdministratorRoleForUser in interface Client
Parameters:: userId - (required); roleId - (required)
Returns:: CatalogApplicationList

removeApplicationTargetFromApplicationAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}")
public void removeApplicationTargetFromApplicationAdministratorRoleForUser(String userId,
                                                                                                                                                                                                                                                                                                        String roleId,
                                                                                                                                                                                                                                                                                                        String appName)

Success

Specified by:: removeApplicationTargetFromApplicationAdministratorRoleForUser in interface Client
Parameters:: userId - (required); roleId - (required); appName - (required)

removeApplicationTargetFromAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
public void removeApplicationTargetFromAdministratorRoleForUser(String userId,
                                                                                                                                                                                                                                                                                                             String roleId,
                                                                                                                                                                                                                                                                                                             String appName,
                                                                                                                                                                                                                                                                                                             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

Specified by:: removeApplicationTargetFromAdministratorRoleForUser in interface Client
Parameters:: userId - (required); roleId - (required); appName - (required); applicationId - (required)

listNetworkZones
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/zones")
public NetworkZoneList listNetworkZones(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.

Specified by:

listNetworkZones in interface Client

Parameters:

filter - Filters zones by usage or id expression (optional)

Returns:

NetworkZoneList

listNetworkZones
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/zones")
public 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.

Specified by:

listNetworkZones in interface Client

Returns:

NetworkZoneList

createNetworkZone

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="POST - /api/v1/zones")
public NetworkZone createNetworkZone(NetworkZone zone)

Add Network Zone Adds a new network zone to your Okta organization.

Specified by:: createNetworkZone in interface Client
Parameters:: zone - (required)
Returns:: NetworkZone

getNetworkZone

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-02-02T10:57:07.429-06:00",
           comments="GET - /api/v1/zones/{zoneId}")
public NetworkZone getNetworkZone(String zoneId)

Get Network Zone Fetches a network zone from your Okta organization by `id`.

Specified by:: getNetworkZone in interface Client
Parameters:: zoneId - (required)
Returns:: NetworkZone

Class DefaultClient

Constructor Summary

Method Summary

Methods inherited from class com.okta.sdk.impl.client.BaseClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.okta.sdk.client.Client

Methods inherited from interface com.okta.sdk.ds.DataStore

Constructor Detail

DefaultClient

DefaultClient

Method Detail

listApplications

listApplications

createApplication

createApplication

getApplication

getApplication

listAuthenticators

getAuthenticator

listAuthorizationServers

listAuthorizationServers

createAuthorizationServer

getAuthorizationServer

listBrands

getBrand

listEmailTemplates

listBrandThemes

getBrandTheme

listDomains

createDomain

deleteDomain

getDomain

verifyDomain

listEventHooks

createEventHook

getEventHook

listFeatures

getFeature

listGroups

listGroups

createGroup

listGroupRules

listGroupRules

createGroupRule

getGroupRule

getGroupRule

getGroup

listGroupAssignedRoles

listGroupAssignedRoles

removeRoleFromGroup

getRole

listApplicationTargetsForApplicationAdministratorRoleForGroup

removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup

removeApplicationTargetFromAdministratorRoleGivenToGroup

listGroupTargetsForGroupRole

removeGroupTargetFromGroupAdministratorRoleGivenToGroup

listIdentityProviders

listIdentityProviders

createIdentityProvider

listIdentityProviderKeys

createIdentityProviderKey

deleteIdentityProviderKey

getIdentityProviderKey

getIdentityProvider

apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost

listInlineHooks

listInlineHooks

createInlineHook

getInlineHook

getLogs

getLogs

listProfileMappings

listProfileMappings

getProfileMapping

getApplicationUserSchema

updateApplicationUserProfile

updateApplicationUserProfile

getGroupSchema

updateGroupSchema

updateGroupSchema