Package com.okta.sdk.client
Interface Client
-
- All Superinterfaces:
DataStore
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00") public interface Client extends DataStore
TheClient
is the main entry point to the Okta Java SDK. A JVM project wishing to communicate with the Okta REST API service must build aClient
instance. After obtaining aClient 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 Description TrustedOrigin
activateOrigin(java.lang.String trustedOriginId)
SuccessLinkedObject
addLinkedObjectDefinition(LinkedObject linkedObject)
SuccessJsonWebKey
apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost(java.lang.String idpId, java.lang.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, java.lang.Boolean activate, java.lang.String oktaAccessGatewayAgent)
Add Application Adds a new application to your Okta organization.AuthorizationServer
createAuthorizationServer(AuthorizationServer authorizationServer)
SuccessDomain
createDomain(Domain domain)
Create Domain Creates your domain.EventHook
createEventHook(EventHook eventHook)
SuccessGroup
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 conditionIdentityProvider
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)
SuccessNetworkZone
createNetworkZone(NetworkZone zone)
Add Network Zone Adds a new network zone to your Okta organization.TrustedOrigin
createOrigin(TrustedOrigin trustedOrigin)
SuccessPolicy
createPolicy(Policy policy)
Creates a policy.Policy
createPolicy(Policy policy, java.lang.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, java.lang.Boolean activate, java.lang.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(java.lang.String trustedOriginId)
Successvoid
deleteDomain(java.lang.String domainId)
Delete Domain Deletes a Domain by `id`.void
deleteIdentityProviderKey(java.lang.String keyId)
Delete Key Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP.Application
getApplication(java.lang.String appId)
Get Application Fetches an application from your Okta organization by `id`.Application
getApplication(java.lang.String appId, java.lang.String expand)
Get Application Fetches an application from your Okta organization by `id`.UserSchema
getApplicationUserSchema(java.lang.String appInstanceId)
Fetches the Schema for an App User Fetches the Schema for an App UserAuthenticator
getAuthenticator(java.lang.String authenticatorId)
SuccessAuthorizationServer
getAuthorizationServer(java.lang.String authServerId)
SuccessBrand
getBrand(java.lang.String brandId)
Get Brand Fetches a brand by `brandId`ThemeResponse
getBrandTheme(java.lang.String brandId, java.lang.String themeId)
Get a theme for a brand Fetches a theme for a brandThreatInsightConfiguration
getCurrentConfiguration()
Gets current ThreatInsight configurationDataStore
getDataStore()
Returns the internalDataStore
of the client.Domain
getDomain(java.lang.String domainId)
Get Domain Fetches a Domain by `id`.EventHook
getEventHook(java.lang.String eventHookId)
SuccessVerifyUserFactorResponse
getFactorTransactionStatus(java.lang.String userId, java.lang.String factorId, java.lang.String transactionId)
Polls factors verification transaction for status.Feature
getFeature(java.lang.String featureId)
SuccessGroup
getGroup(java.lang.String groupId)
List Group Rules Fetches a group from your organization.GroupRule
getGroupRule(java.lang.String ruleId)
Get Group Rule Fetches a specific group rule by id from your organizationGroupRule
getGroupRule(java.lang.String ruleId, java.lang.String expand)
Get Group Rule Fetches a specific group rule by id from your organizationGroupSchema
getGroupSchema()
Fetches the group schema Fetches the group schemaIdentityProvider
getIdentityProvider(java.lang.String idpId)
Get Identity Provider Fetches an IdP by `id`.JsonWebKey
getIdentityProviderKey(java.lang.String keyId)
Get Key Gets a specific IdP Key Credential by `kid`InlineHook
getInlineHook(java.lang.String inlineHookId)
Gets an inline hook by IDLinkedObject
getLinkedObjectDefinition(java.lang.String linkedObjectName)
SuccessLogEventList
getLogs()
Fetch a list of events from your Okta organization system log.LogEventList
getLogs(java.util.Date since, java.util.Date until, java.lang.String filter, java.lang.String q, java.lang.String sortOrder)
Fetch a list of events from your Okta organization system log.NetworkZone
getNetworkZone(java.lang.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(java.lang.String trustedOriginId)
SuccessPolicy
getPolicy(java.lang.String policyId)
Gets a policy.Policy
getPolicy(java.lang.String policyId, java.lang.String expand)
Gets a policy.ProfileMapping
getProfileMapping(java.lang.String mappingId)
Get Profile Mapping Fetches a single Profile Mapping referenced by its ID.Role
getRole(java.lang.String groupId, java.lang.String roleId)
SuccessSession
getSession(java.lang.String sessionId)
Get details about a session.SmsTemplate
getSmsTemplate(java.lang.String templateId)
Get SMS Template Fetches a specific template by `id`User
getUser(java.lang.String userId)
Get User Fetches a user from your Okta organization.OAuth2ScopeConsentGrant
getUserGrant(java.lang.String userId, java.lang.String grantId)
Gets a grant for the specified userOAuth2ScopeConsentGrant
getUserGrant(java.lang.String userId, java.lang.String grantId, java.lang.String expand)
Gets a grant for the specified userUserSchema
getUserSchema(java.lang.String schemaId)
Fetches the schema for a Schema Id.UserType
getUserType(java.lang.String typeId)
Fetches a User Type by ID.ApplicationList
listApplications()
List Applications Enumerates apps added to your organization with pagination.ApplicationList
listApplications(java.lang.String q, java.lang.String filter, java.lang.String expand, java.lang.Boolean includeNonDeleted)
List Applications Enumerates apps added to your organization with pagination.CatalogApplicationList
listApplicationTargetsForApplicationAdministratorRoleForGroup(java.lang.String groupId, java.lang.String roleId)
Lists all App targets for an `APP_ADMIN` Role assigned to a Group.CatalogApplicationList
listApplicationTargetsForApplicationAdministratorRoleForUser(java.lang.String userId, java.lang.String roleId)
Lists all App targets for an `APP_ADMIN` Role assigned to a User.AuthenticatorList
listAuthenticators()
SuccessAuthorizationServerList
listAuthorizationServers()
SuccessAuthorizationServerList
listAuthorizationServers(java.lang.String q)
SuccessBrandList
listBrands()
List Brands List all the brands in your org.ThemeResponseList
listBrandThemes(java.lang.String brandId)
Get Brand Themes List all the themes in your brandDomainListResponse
listDomains()
List Domains List all verified custom Domains for the org.EventHookList
listEventHooks()
SuccessFeatureList
listFeatures()
SuccessOAuth2ScopeConsentGrantList
listGrantsForUserAndClient(java.lang.String userId, java.lang.String clientId)
Lists all grants for a specified user and clientOAuth2ScopeConsentGrantList
listGrantsForUserAndClient(java.lang.String userId, java.lang.String clientId, java.lang.String expand)
Lists all grants for a specified user and clientRoleList
listGroupAssignedRoles(java.lang.String groupId)
SuccessRoleList
listGroupAssignedRoles(java.lang.String groupId, java.lang.String expand)
SuccessGroupRuleList
listGroupRules()
List Group Rules Lists all group rules for your organization.GroupRuleList
listGroupRules(java.lang.String search, java.lang.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(java.lang.String q, java.lang.String search, java.lang.String expand)
List Groups Enumerates groups in your organization with pagination.GroupList
listGroupTargetsForGroupRole(java.lang.String groupId, java.lang.String roleId)
SuccessJsonWebKeyList
listIdentityProviderKeys()
List Keys Enumerates IdP key credentials.IdentityProviderList
listIdentityProviders()
List Identity Providers Enumerates IdPs in your organization with pagination.IdentityProviderList
listIdentityProviders(java.lang.String q, java.lang.String type)
List Identity Providers Enumerates IdPs in your organization with pagination.InlineHookList
listInlineHooks()
SuccessInlineHookList
listInlineHooks(java.lang.String type)
SuccessLinkedObjectList
listLinkedObjectDefinitions()
SuccessNetworkZoneList
listNetworkZones()
List Network Zones Enumerates network zones added to your organization with pagination.NetworkZoneList
listNetworkZones(java.lang.String filter)
List Network Zones Enumerates network zones added to your organization with pagination.TrustedOriginList
listOrigins()
SuccessTrustedOriginList
listOrigins(java.lang.String q, java.lang.String filter)
SuccessPolicyList
listPolicies(java.lang.String type)
Gets all policies with the specified type.PolicyList
listPolicies(java.lang.String type, java.lang.String status, java.lang.String expand)
Gets all policies with the specified type.ProfileMappingList
listProfileMappings()
Enumerates Profile Mappings in your organization with pagination.ProfileMappingList
listProfileMappings(java.lang.String sourceId, java.lang.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(java.lang.String q, java.lang.String filter, java.lang.String search, java.lang.String sortBy, java.lang.String sortOrder)
List Users Lists users in your organization with pagination in most cases.UserTypeList
listUserTypes()
Fetches all User Types in your orgUser
partialUpdateUser(User user, java.lang.String userId)
Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.User
partialUpdateUser(User user, java.lang.String userId, java.lang.Boolean strict)
Fetch a user by `id`, `login`, or `login shortname` if the short name is unambiguous.void
removeApplicationTargetFromAdministratorRoleForUser(java.lang.String userId, java.lang.String roleId, java.lang.String appName, java.lang.String applicationId)
Remove App Instance Target to App Administrator Role given to a User Remove App Instance Target to App Administrator Role given to a Uservoid
removeApplicationTargetFromAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String appName, java.lang.String applicationId)
Remove App Instance Target to App Administrator Role given to a Group Remove App Instance Target to App Administrator Role given to a Groupvoid
removeApplicationTargetFromApplicationAdministratorRoleForUser(java.lang.String userId, java.lang.String roleId, java.lang.String appName)
Successvoid
removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String appName)
Successvoid
removeGroupTargetFromGroupAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String targetGroupId)
void
removeRoleFromGroup(java.lang.String groupId, java.lang.String roleId)
Unassigns a Role from a GroupUserSchema
updateApplicationUserProfile(java.lang.String appInstanceId)
Partial updates on the User Profile properties of the Application User Schema.UserSchema
updateApplicationUserProfile(java.lang.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 schemaGroupSchema
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 schemaUserSchema
updateUserProfile(java.lang.String schemaId, UserSchema userSchema)
Partial updates on the User Profile properties of the user schema.Domain
verifyDomain(java.lang.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 internalDataStore
of the client. It is typically not necessary to invoke this method as the Client implements theDataStore
API and will delegate to this instance automatically.- Returns:
- the client's internal
DataStore
.
-
listApplications
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/apps") ApplicationList listApplications(java.lang.String q, java.lang.String filter, java.lang.String expand, java.lang.Boolean includeNonDeleted)
List Applications Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.- Parameters:
q
- (optional)filter
- Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)expand
- Traverses users link relationship and optionally embeds Application User resource (optional)includeNonDeleted
- (optional, default to false)- Returns:
- ApplicationList
-
listApplications
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/apps") Application createApplication(Application application, java.lang.Boolean activate, java.lang.String oktaAccessGatewayAgent)
Add Application Adds a new application to your Okta organization.- Parameters:
application
- (required)activate
- Executes activation lifecycle operation when creating the app (optional, default to true)oktaAccessGatewayAgent
- (optional)- Returns:
- Application
-
createApplication
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/apps/{appId}") Application getApplication(java.lang.String appId, java.lang.String expand)
Get Application Fetches an application from your Okta organization by `id`.- Parameters:
appId
- (required)expand
- (optional)- Returns:
- Application
-
getApplication
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/apps/{appId}") Application getApplication(java.lang.String appId)
Get Application Fetches an application from your Okta organization by `id`.- Parameters:
appId
- (required)- Returns:
- Application
-
listAuthenticators
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/authenticators") AuthenticatorList listAuthenticators()
Success- Returns:
- AuthenticatorList
-
getAuthenticator
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/authenticators/{authenticatorId}") Authenticator getAuthenticator(java.lang.String authenticatorId)
Success- Parameters:
authenticatorId
- (required)- Returns:
- Authenticator
-
listAuthorizationServers
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/authorizationServers") AuthorizationServerList listAuthorizationServers(java.lang.String q)
Success- Parameters:
q
- (optional)- Returns:
- AuthorizationServerList
-
listAuthorizationServers
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/authorizationServers") AuthorizationServerList listAuthorizationServers()
Success- Returns:
- AuthorizationServerList
-
createAuthorizationServer
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/authorizationServers/{authServerId}") AuthorizationServer getAuthorizationServer(java.lang.String authServerId)
Success- Parameters:
authServerId
- (required)- Returns:
- AuthorizationServer
-
listBrands
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/brands/{brandId}") Brand getBrand(java.lang.String brandId)
Get Brand Fetches a brand by `brandId`- Parameters:
brandId
- (required)- Returns:
- Brand
-
listBrandThemes
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/brands/{brandId}/themes") ThemeResponseList listBrandThemes(java.lang.String brandId)
Get Brand Themes List all the themes in your brand- Parameters:
brandId
- (required)- Returns:
- ThemeResponseList
-
getBrandTheme
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/brands/{brandId}/themes/{themeId}") ThemeResponse getBrandTheme(java.lang.String brandId, java.lang.String themeId)
Get a theme for a brand Fetches a theme for a brand- Parameters:
brandId
- (required)themeId
- (required)- Returns:
- ThemeResponse
-
listDomains
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/domains/{domainId}") void deleteDomain(java.lang.String domainId)
Delete Domain Deletes a Domain by `id`.- Parameters:
domainId
- (required)
-
getDomain
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/domains/{domainId}") Domain getDomain(java.lang.String domainId)
Get Domain Fetches a Domain by `id`.- Parameters:
domainId
- (required)- Returns:
- Domain
-
verifyDomain
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/domains/{domainId}/verify") Domain verifyDomain(java.lang.String domainId)
Verify Domain Verifies the Domain by `id`.- Parameters:
domainId
- (required)- Returns:
- Domain
-
listEventHooks
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/eventHooks") EventHookList listEventHooks()
Success- Returns:
- EventHookList
-
createEventHook
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/eventHooks/{eventHookId}") EventHook getEventHook(java.lang.String eventHookId)
Success- Parameters:
eventHookId
- (required)- Returns:
- EventHook
-
listFeatures
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/features") FeatureList listFeatures()
Success- Returns:
- FeatureList
-
getFeature
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/features/{featureId}") Feature getFeature(java.lang.String featureId)
Success- Parameters:
featureId
- (required)- Returns:
- Feature
-
listGroups
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups") GroupList listGroups(java.lang.String q, java.lang.String search, java.lang.String expand)
List Groups Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.- Parameters:
q
- Searches the name property of groups for matching value (optional)search
- Filter expression for groups (optional)expand
- If specified, it causes additional metadata to be included in the response. (optional)- Returns:
- GroupList
-
listGroups
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/rules") GroupRuleList listGroupRules(java.lang.String search, java.lang.String expand)
List Group Rules Lists all group rules for your organization.- Parameters:
search
- Specifies the keyword to search fules for (optional)expand
- If specified as `groupIdToGroupNameMap`, then show group names (optional)- Returns:
- GroupRuleList
-
listGroupRules
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/rules/{ruleId}") GroupRule getGroupRule(java.lang.String ruleId, java.lang.String expand)
Get Group Rule Fetches a specific group rule by id from your organization- Parameters:
ruleId
- (required)expand
- (optional)- Returns:
- GroupRule
-
getGroupRule
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/rules/{ruleId}") GroupRule getGroupRule(java.lang.String ruleId)
Get Group Rule Fetches a specific group rule by id from your organization- Parameters:
ruleId
- (required)- Returns:
- GroupRule
-
getGroup
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}") Group getGroup(java.lang.String groupId)
List Group Rules Fetches a group from your organization.- Parameters:
groupId
- (required)- Returns:
- Group
-
listGroupAssignedRoles
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/roles") RoleList listGroupAssignedRoles(java.lang.String groupId, java.lang.String expand)
Success- Parameters:
groupId
- (required)expand
- (optional)- Returns:
- RoleList
-
listGroupAssignedRoles
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/roles") RoleList listGroupAssignedRoles(java.lang.String groupId)
Success- Parameters:
groupId
- (required)- Returns:
- RoleList
-
removeRoleFromGroup
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}") void removeRoleFromGroup(java.lang.String groupId, java.lang.String roleId)
Unassigns a Role from a Group- Parameters:
groupId
- (required)roleId
- (required)
-
getRole
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/roles/{roleId}") Role getRole(java.lang.String groupId, java.lang.String roleId)
Success- Parameters:
groupId
- (required)roleId
- (required)- Returns:
- Role
-
listApplicationTargetsForApplicationAdministratorRoleForGroup
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps") CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForGroup(java.lang.String groupId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}") void removeApplicationTargetFromApplicationAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String appName)
Success- Parameters:
groupId
- (required)roleId
- (required)appName
- (required)
-
removeApplicationTargetFromAdministratorRoleGivenToGroup
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}") void removeApplicationTargetFromAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String appName, java.lang.String applicationId)
Remove App Instance Target to App Administrator Role given to a Group Remove App Instance Target to App Administrator Role given to a Group- Parameters:
groupId
- (required)roleId
- (required)appName
- (required)applicationId
- (required)
-
listGroupTargetsForGroupRole
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups") GroupList listGroupTargetsForGroupRole(java.lang.String groupId, java.lang.String roleId)
Success- Parameters:
groupId
- (required)roleId
- (required)- Returns:
- GroupList
-
removeGroupTargetFromGroupAdministratorRoleGivenToGroup
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId}") void removeGroupTargetFromGroupAdministratorRoleGivenToGroup(java.lang.String groupId, java.lang.String roleId, java.lang.String targetGroupId)
- Parameters:
groupId
- (required)roleId
- (required)targetGroupId
- (required)
-
listIdentityProviders
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/idps") IdentityProviderList listIdentityProviders(java.lang.String q, java.lang.String type)
List Identity Providers Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.- Parameters:
q
- Searches the name property of IdPs for matching value (optional)type
- Filters IdPs by type (optional)- Returns:
- IdentityProviderList
-
listIdentityProviders
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/idps/credentials/keys/{keyId}") void deleteIdentityProviderKey(java.lang.String keyId)
Delete Key Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP.- Parameters:
keyId
- (required)
-
getIdentityProviderKey
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/idps/credentials/keys/{keyId}") JsonWebKey getIdentityProviderKey(java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/idps/{idpId}") IdentityProvider getIdentityProvider(java.lang.String idpId)
Get Identity Provider Fetches an IdP by `id`.- Parameters:
idpId
- (required)- Returns:
- IdentityProvider
-
apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/idps/{idpId}/credentials/csrs/{csrId}/lifecycle/publish") JsonWebKey apiV1IdpsIdpIdCredentialsCsrsCsrIdLifecyclePublishPost(java.lang.String idpId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/inlineHooks") InlineHookList listInlineHooks(java.lang.String type)
Success- Parameters:
type
- (optional)- Returns:
- InlineHookList
-
listInlineHooks
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/inlineHooks") InlineHookList listInlineHooks()
Success- Returns:
- InlineHookList
-
createInlineHook
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/inlineHooks/{inlineHookId}") InlineHook getInlineHook(java.lang.String inlineHookId)
Gets an inline hook by ID- Parameters:
inlineHookId
- (required)- Returns:
- InlineHook
-
getLogs
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/logs") LogEventList getLogs(java.util.Date since, java.util.Date until, java.lang.String filter, java.lang.String q, java.lang.String sortOrder)
Fetch a list of events from your Okta organization system log. The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API- Parameters:
since
- (optional)until
- (optional)filter
- (optional)q
- (optional)sortOrder
- (optional, default to ASCENDING)- Returns:
- LogEventList
-
getLogs
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/mappings") ProfileMappingList listProfileMappings(java.lang.String sourceId, java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/mappings/{mappingId}") ProfileMapping getProfileMapping(java.lang.String mappingId)
Get Profile Mapping Fetches a single Profile Mapping referenced by its ID.- Parameters:
mappingId
- (required)- Returns:
- ProfileMapping
-
getApplicationUserSchema
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/meta/schemas/apps/{appInstanceId}/default") UserSchema getApplicationUserSchema(java.lang.String appInstanceId)
Fetches the Schema for an App User Fetches the Schema for an App User- Parameters:
appInstanceId
- (required)- Returns:
- UserSchema
-
updateApplicationUserProfile
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default") UserSchema updateApplicationUserProfile(java.lang.String appInstanceId, UserSchema body)
Partial updates on the User Profile properties of the Application User Schema. Partial updates on the User Profile properties of the Application User Schema.- Parameters:
appInstanceId
- (required)body
- (optional)- Returns:
- UserSchema
-
updateApplicationUserProfile
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/meta/schemas/apps/{appInstanceId}/default") UserSchema updateApplicationUserProfile(java.lang.String appInstanceId)
Partial updates on the User Profile properties of the Application User Schema. Partial updates on the User Profile properties of the Application User Schema.- Parameters:
appInstanceId
- (required)- Returns:
- UserSchema
-
getGroupSchema
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/meta/schemas/user/linkedObjects") LinkedObjectList listLinkedObjectDefinitions()
Success- Returns:
- LinkedObjectList
-
addLinkedObjectDefinition
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/meta/schemas/user/linkedObjects/{linkedObjectName}") LinkedObject getLinkedObjectDefinition(java.lang.String linkedObjectName)
Success- Parameters:
linkedObjectName
- (required)- Returns:
- LinkedObject
-
getUserSchema
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/meta/schemas/user/{schemaId}") UserSchema getUserSchema(java.lang.String schemaId)
Fetches the schema for a Schema Id. Fetches the schema for a Schema Id.- Parameters:
schemaId
- (required)- Returns:
- UserSchema
-
updateUserProfile
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/meta/schemas/user/{schemaId}") UserSchema updateUserProfile(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/meta/types/user/{typeId}") UserType getUserType(java.lang.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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/policies") PolicyList listPolicies(java.lang.String type, java.lang.String status, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/policies") PolicyList listPolicies(java.lang.String type)
Gets all policies with the specified type.- Parameters:
type
- (required)- Returns:
- PolicyList
-
createPolicy
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/policies") Policy createPolicy(Policy policy, java.lang.Boolean activate)
Creates a policy.- Parameters:
policy
- (required)activate
- (optional, default to true)- Returns:
- Policy
-
createPolicy
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/policies/{policyId}") Policy getPolicy(java.lang.String policyId, java.lang.String expand)
Gets a policy.- Parameters:
policyId
- (required)expand
- (optional, default to )- Returns:
- Policy
-
getPolicy
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/policies/{policyId}") Policy getPolicy(java.lang.String policyId)
Gets a policy.- Parameters:
policyId
- (required)- Returns:
- Policy
-
createSession
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/sessions/{sessionId}") Session getSession(java.lang.String sessionId)
Get details about a session.- Parameters:
sessionId
- (required)- Returns:
- Session
-
listSmsTemplates
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/templates/sms/{templateId}") SmsTemplate getSmsTemplate(java.lang.String templateId)
Get SMS Template Fetches a specific template by `id`- Parameters:
templateId
- (required)- Returns:
- SmsTemplate
-
getCurrentConfiguration
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/threats/configuration") ThreatInsightConfiguration getCurrentConfiguration()
Gets current ThreatInsight configuration- Returns:
- ThreatInsightConfiguration
-
listOrigins
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/trustedOrigins") TrustedOriginList listOrigins(java.lang.String q, java.lang.String filter)
Success- Parameters:
q
- (optional)filter
- (optional)- Returns:
- TrustedOriginList
-
listOrigins
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/trustedOrigins") TrustedOriginList listOrigins()
Success- Returns:
- TrustedOriginList
-
createOrigin
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/trustedOrigins/{trustedOriginId}") TrustedOrigin getOrigin(java.lang.String trustedOriginId)
Success- Parameters:
trustedOriginId
- (required)- Returns:
- TrustedOrigin
-
activateOrigin
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/activate") TrustedOrigin activateOrigin(java.lang.String trustedOriginId)
Success- Parameters:
trustedOriginId
- (required)- Returns:
- TrustedOrigin
-
deactivateOrigin
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/trustedOrigins/{trustedOriginId}/lifecycle/deactivate") TrustedOrigin deactivateOrigin(java.lang.String trustedOriginId)
Success- Parameters:
trustedOriginId
- (required)- Returns:
- TrustedOrigin
-
listUsers
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users") UserList listUsers(java.lang.String q, java.lang.String filter, java.lang.String search, java.lang.String sortBy, java.lang.String sortOrder)
List Users Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.- Parameters:
q
- Finds a user that matches firstName, lastName, and email properties (optional)filter
- Filters users with a supported expression for a subset of properties (optional)search
- Searches for users with a supported filtering expression for most properties (optional)sortBy
- (optional)sortOrder
- (optional)- Returns:
- UserList
-
listUsers
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/users") User createUser(CreateUserRequest body, java.lang.Boolean activate, java.lang.Boolean provider, UserNextLogin nextLogin)
Create User Creates a new user in your Okta organization with or without credentials.- Parameters:
body
- (required)activate
- Executes activation lifecycle operation when creating the user (optional, default to true)provider
- Indicates whether to create a user with a specified authentication provider (optional, default to false)nextLogin
- With activate=true, set nextLogin to \"changePassword\" to have the password be EXPIRED, so user must change it the next time they log in. (optional, default to )- Returns:
- User
-
createUser
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}") User getUser(java.lang.String userId)
Get User Fetches a user from your Okta organization.- Parameters:
userId
- (required)- Returns:
- User
-
partialUpdateUser
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/users/{userId}") User partialUpdateUser(User user, java.lang.String userId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="POST - /api/v1/users/{userId}") User partialUpdateUser(User user, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants") OAuth2ScopeConsentGrantList listGrantsForUserAndClient(java.lang.String userId, java.lang.String clientId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/clients/{clientId}/grants") OAuth2ScopeConsentGrantList listGrantsForUserAndClient(java.lang.String userId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId}") VerifyUserFactorResponse getFactorTransactionStatus(java.lang.String userId, java.lang.String factorId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/grants/{grantId}") OAuth2ScopeConsentGrant getUserGrant(java.lang.String userId, java.lang.String grantId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/grants/{grantId}") OAuth2ScopeConsentGrant getUserGrant(java.lang.String userId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps") CatalogApplicationList listApplicationTargetsForApplicationAdministratorRoleForUser(java.lang.String userId, java.lang.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="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}") void removeApplicationTargetFromApplicationAdministratorRoleForUser(java.lang.String userId, java.lang.String roleId, java.lang.String appName)
Success- Parameters:
userId
- (required)roleId
- (required)appName
- (required)
-
removeApplicationTargetFromAdministratorRoleForUser
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="DELETE - /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{applicationId}") void removeApplicationTargetFromAdministratorRoleForUser(java.lang.String userId, java.lang.String roleId, java.lang.String appName, java.lang.String applicationId)
Remove App Instance Target to App Administrator Role given to a User Remove App Instance Target to App Administrator Role given to a User- Parameters:
userId
- (required)roleId
- (required)appName
- (required)applicationId
- (required)
-
listNetworkZones
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/zones") NetworkZoneList listNetworkZones(java.lang.String filter)
List Network Zones Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.- Parameters:
filter
- Filters zones by usage or id expression (optional)- Returns:
- NetworkZoneList
-
listNetworkZones
@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen", date="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06: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="2022-02-14T12:54:39.514-06:00", comments="GET - /api/v1/zones/{zoneId}") NetworkZone getNetworkZone(java.lang.String zoneId)
Get Network Zone Fetches a network zone from your Okta organization by `id`.- Parameters:
zoneId
- (required)- Returns:
- NetworkZone
-
-