Client (Okta Java SDK 8.2.5 API)

All Superinterfaces:

DataStore

All Known Implementing Classes:

DefaultClient
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
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 Summary

All Methods Instance Methods Abstract 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
`DataStore`	`getDataStore()` Returns the internal `DataStore` of the client.
`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 interface com.okta.sdk.ds.DataStore
create, delete, getCacheManager, getClientCredentials, getResource, http, instantiate, isReady, save

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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/apps")
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.

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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/apps")
Application createApplication(Application application,
                                                                                                                                                                                                Boolean activate,
                                                                                                                                                                                                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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/apps")
Application createApplication(Application application)

Add Application Adds a new application to your Okta organization.

Parameters:: application - (required)
Returns:: Application

getApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/apps/{appId}")
Application getApplication(String appId,
                                                                                                                                                                                                    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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/apps/{appId}")
Application getApplication(String appId)

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

Parameters:: appId - (required)
Returns:: Application

listAuthenticators

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authenticators")
AuthenticatorList listAuthenticators()

Success

Returns:: AuthenticatorList

getAuthenticator

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authenticators/{authenticatorId}")
Authenticator getAuthenticator(String authenticatorId)

Success

Parameters:: authenticatorId - (required)
Returns:: Authenticator

listAuthorizationServers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authorizationServers")
AuthorizationServerList listAuthorizationServers(String q)

Success

Parameters:: q - (optional)
Returns:: AuthorizationServerList

listAuthorizationServers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authorizationServers")
AuthorizationServerList listAuthorizationServers()

Success

Returns:: AuthorizationServerList

createAuthorizationServer

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/authorizationServers")
AuthorizationServer createAuthorizationServer(AuthorizationServer authorizationServer)

Success

Parameters:: authorizationServer - (required)
Returns:: AuthorizationServer

getAuthorizationServer

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/authorizationServers/{authServerId}")
AuthorizationServer getAuthorizationServer(String authServerId)

Success

Parameters:: authServerId - (required)
Returns:: AuthorizationServer

listBrands

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}")
Brand getBrand(String brandId)

Get Brand Fetches a brand by `brandId`

Parameters:: brandId - (required)
Returns:: Brand

listEmailTemplates

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/templates/email")
EmailTemplateList listEmailTemplates(String brandId)

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

Parameters:: brandId - (required)
Returns:: EmailTemplateList

listBrandThemes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/themes")
ThemeResponseList listBrandThemes(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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/brands/{brandId}/themes/{themeId}")
ThemeResponse getBrandTheme(String brandId,
                                                                                                                                                                                                                          String themeId)

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

Parameters:: brandId - (required); themeId - (required)
Returns:: ThemeResponse

listDomains

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/domains")
Domain createDomain(Domain domain)

Create Domain Creates your domain.

Parameters:: domain - (required)
Returns:: Domain

deleteDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/domains/{domainId}")
void deleteDomain(String domainId)

Delete Domain Deletes a Domain by `id`.

Parameters:: domainId - (required)

getDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/domains/{domainId}")
Domain getDomain(String domainId)

Get Domain Fetches a Domain by `id`.

Parameters:: domainId - (required)
Returns:: Domain

verifyDomain

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/domains/{domainId}/verify")
Domain verifyDomain(String domainId)

Verify Domain Verifies the Domain by `id`.

Parameters:: domainId - (required)
Returns:: Domain

listEventHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/eventHooks")
EventHookList listEventHooks()

Success

Returns:: EventHookList

createEventHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/eventHooks")
EventHook createEventHook(EventHook eventHook)

Success

Parameters:: eventHook - (required)
Returns:: EventHook

getEventHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/eventHooks/{eventHookId}")
EventHook getEventHook(String eventHookId)

Success

Parameters:: eventHookId - (required)
Returns:: EventHook

listFeatures

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/features")
FeatureList listFeatures()

Success

Returns:: FeatureList

getFeature

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/features/{featureId}")
Feature getFeature(String featureId)

Success

Parameters:: featureId - (required)
Returns:: Feature

listGroups

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups")
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.

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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/rules")
GroupRuleList listGroupRules(String search,
                                                                                                                                                                                                      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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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

getGroupRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/rules/{ruleId}")
GroupRule getGroupRule(String ruleId,
                                                                                                                                                                                                         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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/rules/{ruleId}")
GroupRule getGroupRule(String ruleId)

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

Parameters:: ruleId - (required)
Returns:: GroupRule

getGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}")
Group getGroup(String groupId)

List Group Rules Fetches a group from your organization.

Parameters:: groupId - (required)
Returns:: Group

listGroupAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}/roles")
RoleList listGroupAssignedRoles(String groupId,
                                                                                                                                                                                                                   String expand)

Success

Parameters:: groupId - (required); expand - (optional)
Returns:: RoleList

listGroupAssignedRoles

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}/roles")
RoleList listGroupAssignedRoles(String groupId)

Success

Parameters:: groupId - (required)
Returns:: RoleList

removeRoleFromGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}")
void removeRoleFromGroup(String groupId,
                                                                                                                                                                                                                        String roleId)

Unassigns a Role from a Group

Parameters:: groupId - (required); roleId - (required)

getRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}")
Role getRole(String groupId,
                                                                                                                                                                                                         String roleId)

Success

Parameters:: groupId - (required); roleId - (required)
Returns:: Role

listApplicationTargetsForApplicationAdministratorRoleForGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps")
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.

Parameters:: groupId - (required); roleId - (required)
Returns:: CatalogApplicationList

removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}")
void removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup(String groupId,
                                                                                                                                                                                                                                                                                                       String roleId,
                                                                                                                                                                                                                                                                                                       String appName)

Success

Parameters:: groupId - (required); roleId - (required); appName - (required)

removeApplicationTargetFromAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
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

Parameters:: groupId - (required); roleId - (required); appName - (required); applicationId - (required)

listGroupTargetsForGroupRole

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups")
GroupList listGroupTargetsForGroupRole(String groupId,
                                                                                                                                                                                                                                                  String roleId)

Success

Parameters:: groupId - (required); roleId - (required)
Returns:: GroupList

removeGroupTargetFromGroupAdministratorRoleGivenToGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}")
void removeGroupTargetFromGroupAdministratorRoleGivenToGroup(String groupId,
                                                                                                                                                                                                                                                                                           String roleId,
                                                                                                                                                                                                                                                                                           String targetGroupId)

Parameters:: groupId - (required); roleId - (required); targetGroupId - (required)

listIdentityProviders

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/idps")
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.

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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/idps/credentials/keys")
JsonWebKeyList listIdentityProviderKeys()

List Keys Enumerates IdP key credentials.

Returns:: JsonWebKeyList

createIdentityProviderKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/idps/credentials/keys")
JsonWebKey createIdentityProviderKey(JsonWebKey jsonWebKey)

Add X.509 Certificate Public Key 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="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/idps/credentials/keys/{keyId}")
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.

Parameters:: keyId - (required)

getIdentityProviderKey

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/idps/credentials/keys/{keyId}")
JsonWebKey getIdentityProviderKey(String keyId)

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

Parameters:: keyId - (required)
Returns:: JsonWebKey

getIdentityProvider

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/idps/{idpId}")
IdentityProvider getIdentityProvider(String idpId)

Get Identity Provider Fetches an IdP by `id`.

Parameters:: idpId - (required)
Returns:: IdentityProvider

apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish")
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.

Parameters:: idpId - (required); csrId - (required)
Returns:: JsonWebKey

listInlineHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/inlineHooks")
InlineHookList listInlineHooks(String type)

Success

Parameters:: type - (optional)
Returns:: InlineHookList

listInlineHooks

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/inlineHooks")
InlineHookList listInlineHooks()

Success

Returns:: InlineHookList

createInlineHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/inlineHooks")
InlineHook createInlineHook(InlineHook inlineHook)

Success

Parameters:: inlineHook - (required)
Returns:: InlineHook

getInlineHook

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/inlineHooks/{inlineHookId}")
InlineHook getInlineHook(String inlineHookId)

Gets an inline hook by ID

Parameters:: inlineHookId - (required)
Returns:: InlineHook

getLogs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/logs")
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

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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/mappings")
ProfileMappingList listProfileMappings(String sourceId,
                                                                                                                                                                                                            String targetId)

Enumerates Profile Mappings in your organization with pagination.

Parameters:: sourceId - (optional); targetId - (optional, default to )
Returns:: ProfileMappingList

listProfileMappings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/mappings")
ProfileMappingList listProfileMappings()

Enumerates Profile Mappings in your organization with pagination.

Returns:: ProfileMappingList

getProfileMapping

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/mappings/{mappingId}")
ProfileMapping getProfileMapping(String mappingId)

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

Parameters:: mappingId - (required)
Returns:: ProfileMapping

getApplicationUserSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/schemas/apps/{appInstanceId}/default")
UserSchema getApplicationUserSchema(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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
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.

Parameters:: appInstanceId - (required); body - (optional)
Returns:: UserSchema

updateApplicationUserProfile

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default")
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.

Parameters:: appInstanceId - (required)
Returns:: UserSchema

getGroupSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects")
LinkedObjectList listLinkedObjectDefinitions()

Success

Returns:: LinkedObjectList

addLinkedObjectDefinition

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/schemas/user/linkedObjects")
LinkedObject addLinkedObjectDefinition(LinkedObject linkedObject)

Success

Parameters:: linkedObject - (required)
Returns:: LinkedObject

getLinkedObjectDefinition

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}")
LinkedObject getLinkedObjectDefinition(String linkedObjectName)

Success

Parameters:: linkedObjectName - (required)
Returns:: LinkedObject

getUserSchema

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/schemas/user/{schemaId}")
UserSchema getUserSchema(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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/schemas/user/{schemaId}")
UserSchema updateUserProfile(String schemaId,
                                                                                                                                                                                                                       UserSchema userSchema)

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

Parameters:: schemaId - (required); userSchema - (required)
Returns:: UserSchema

listUserTypes

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/types/user")
UserTypeList listUserTypes()

Fetches all User Types in your org

Returns:: UserTypeList

createUserType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/meta/types/user")
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.

Parameters:: userType - (required)
Returns:: UserType

getUserType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/meta/types/user/{typeId}")
UserType getUserType(String typeId)

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

Parameters:: typeId - (required)
Returns:: UserType

getOrgSettings

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/org")
OrgSetting getOrgSettings()

Get org settings Get settings of your organization.

Returns:: OrgSetting

listPolicies

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/policies")
PolicyList listPolicies(String type,
                                                                                                                                                                                             String status,
                                                                                                                                                                                             String expand)

Gets all policies with the specified type.

Parameters:: type - (required); status - (optional); expand - (optional, default to )
Returns:: PolicyList

listPolicies

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/policies")
PolicyList listPolicies(String type)

Gets all policies with the specified type.

Parameters:: type - (required)
Returns:: PolicyList

createPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/policies")
Policy createPolicy(Policy policy,
                                                                                                                                                                                          Boolean activate)

Creates a policy.

Parameters:: policy - (required); activate - (optional, default to true)
Returns:: Policy

createPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/policies")
Policy createPolicy(Policy policy)

Creates a policy.

Parameters:: policy - (required)
Returns:: Policy

getPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/policies/{policyId}")
Policy getPolicy(String policyId,
                                                                                                                                                                                                 String expand)

Gets a policy.

Parameters:: policyId - (required); expand - (optional, default to )
Returns:: Policy

getPolicy

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/policies/{policyId}")
Policy getPolicy(String policyId)

Gets a policy.

Parameters:: policyId - (required)
Returns:: Policy

createSession
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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

getSession

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/sessions/{sessionId}")
Session getSession(String sessionId)

Get details about a session.

Parameters:: sessionId - (required)
Returns:: Session

listSmsTemplates

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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

getSmsTemplate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/templates/sms/{templateId}")
SmsTemplate getSmsTemplate(String templateId)

Get SMS Template Fetches a specific template by `id`

Parameters:: templateId - (required)
Returns:: SmsTemplate

getCurrentConfiguration

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/threats/configuration")
ThreatInsightConfiguration getCurrentConfiguration()

Gets current ThreatInsight configuration

Returns:: ThreatInsightConfiguration

listOrigins

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/trustedOrigins")
TrustedOriginList listOrigins(String q,
                                                                                                                                                                                                         String filter)

Success

Parameters:: q - (optional); filter - (optional)
Returns:: TrustedOriginList

listOrigins

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/trustedOrigins")
TrustedOriginList listOrigins()

Success

Returns:: TrustedOriginList

createOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/trustedOrigins")
TrustedOrigin createOrigin(TrustedOrigin trustedOrigin)

Success

Parameters:: trustedOrigin - (required)
Returns:: TrustedOrigin

getOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/trustedOrigins/{trustedOriginId}")
TrustedOrigin getOrigin(String trustedOriginId)

Success

Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

activateOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate")
TrustedOrigin activateOrigin(String trustedOriginId)

Success

Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

deactivateOrigin

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate")
TrustedOrigin deactivateOrigin(String trustedOriginId)

Success

Parameters:: trustedOriginId - (required)
Returns:: TrustedOrigin

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users")
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.

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="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users")
User createUser(CreateUserRequest body,
                                                                                                                                                                                   Boolean activate,
                                                                                                                                                                                   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, default to )
Returns:: User

createUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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

getUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}")
User getUser(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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}")
User partialUpdateUser(User user,
                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                   Boolean strict)

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="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}")
User partialUpdateUser(User user,
                                                                                                                                                                                                   String userId)

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

Parameters:: user - (required); userId - (required)
Returns:: User

listGrantsForUserAndClient

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
OAuth2ScopeConsentGrantList listGrantsForUserAndClient(String userId,
                                                                                                                                                                                                                                                            String clientId,
                                                                                                                                                                                                                                                            String expand)

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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants")
OAuth2ScopeConsentGrantList listGrantsForUserAndClient(String userId,
                                                                                                                                                                                                                                                            String clientId)

Lists all grants for a specified user and client

Parameters:: userId - (required); clientId - (required)
Returns:: OAuth2ScopeConsentGrantList

getFactorTransactionStatus

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}")
VerifyUserFactorResponse getFactorTransactionStatus(String userId,
                                                                                                                                                                                                                                                                               String factorId,
                                                                                                                                                                                                                                                                               String transactionId)

Polls factors verification transaction for status.

Parameters:: userId - (required); factorId - (required); transactionId - (required)
Returns:: VerifyUserFactorResponse

getUserGrant

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
OAuth2ScopeConsentGrant getUserGrant(String userId,
                                                                                                                                                                                                                                 String grantId,
                                                                                                                                                                                                                                 String expand)

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="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/grants/{grantId}")
OAuth2ScopeConsentGrant getUserGrant(String userId,
                                                                                                                                                                                                                                 String grantId)

Gets a grant for the specified user

Parameters:: userId - (required); grantId - (required)
Returns:: OAuth2ScopeConsentGrant

listApplicationTargetsForApplicationAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps")
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.

Parameters:: userId - (required); roleId - (required)
Returns:: CatalogApplicationList

removeApplicationTargetFromApplicationAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}")
void removeApplicationTargetFromApplicationAdministratorRoleForUser(String userId,
                                                                                                                                                                                                                                                                                                String roleId,
                                                                                                                                                                                                                                                                                                String appName)

Success

Parameters:: userId - (required); roleId - (required); appName - (required)

removeApplicationTargetFromAdministratorRoleForUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}")
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

Parameters:: userId - (required); roleId - (required); appName - (required); applicationId - (required)

listNetworkZones
```
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/zones")
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.

Parameters:

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

Returns:

NetworkZoneList

listNetworkZones

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           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="2023-07-07T09:07:50.516-05:00",
           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

getNetworkZone

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/zones/{zoneId}")
NetworkZone getNetworkZone(String zoneId)

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

Parameters:: zoneId - (required)
Returns:: NetworkZone

Interface Client

Method Summary

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

Method Detail

getDataStore

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

listLinkedObjectDefinitions

addLinkedObjectDefinition

getLinkedObjectDefinition

getUserSchema

updateUserProfile

listUserTypes