com.okta.sdk.impl.client

Class DefaultClient

java.lang.Object

com.okta.sdk.impl.client.AbstractClient

com.okta.sdk.impl.client.DefaultClient

All Implemented Interfaces:

Client, DataStore

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00")
public class DefaultClient
extends AbstractClient

Constructor Summary

Constructors

Constructor and Description
DefaultClient(ClientCredentialsResolver clientCredentialsResolver, BaseUrlResolver baseUrlResolver, Proxy proxy, CacheManager cacheManager, AuthenticationScheme authenticationScheme, RequestAuthenticatorFactory requestAuthenticatorFactory, int connectionTimeout) Instantiates a new Client instance that will communicate with the Okta REST API.

Method Summary

Modifier and Type	Method and Description
Application	createApplication(Application application) Add Application Adds a new application to your Okta organization.
Application	createApplication(Application application, Boolean activate) Add Application Adds a new application to your Okta organization.
Group	createGroup(Group group) Add Group Adds a new group with `OKTA_GROUP` type to your organization.
GroupRule	createRule(GroupRule groupRule) Create Group Rule Creates a group rule to dynamically add users to the specified group if they match the condition
Session	createSession(CreateSessionRequest createSessionRequest) Create Session with Session Token Creates a new session for a user with a valid session token.
User	createUser(User body) Create User Creates a new user in your Okta organization with or without credentials.
User	createUser(User body, Boolean activate, Boolean provider) Create User Creates a new user in your Okta organization with or without credentials.
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`.
Group	getGroup(String groupId) List Group Rules Lists all group rules for your organization.
Group	getGroup(String groupId, String expand) List Group Rules Lists all group rules for your organization.
LogEventList	getLogs() Fetch a list of events from your Okta organization system log.
LogEventList	getLogs(String until, String since, String filter, String q, String sortOrder) Fetch a list of events from your Okta organization system log.
GroupRule	getRule(String ruleId) Get Group Rule Fetches a specific group rule by id from your organization
Session	getSession(String sessionId) Get details about a session.
User	getUser(String userId) Get User Fetches a user from your Okta organization.
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.
GroupList	listGroups() List Groups Enumerates groups in your organization with pagination.
GroupList	listGroups(String q, String filter, String expand) List Groups Enumerates groups in your organization with pagination.
GroupRuleList	listRules() List Group Rules Lists all group rules for your organization.
UserList	listUsers() List Users Lists users in your organization with pagination in most cases.
UserList	listUsers(String q, String filter, String format, String search, String expand) List Users Lists users in your organization with pagination in most cases.

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

createDataStore, createRequestExecutor, getCacheManager, getClientCredentials, getDataStore, getResource, instantiate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultClient

public DefaultClient(ClientCredentialsResolver clientCredentialsResolver,
                     BaseUrlResolver baseUrlResolver,
                     Proxy proxy,
                     CacheManager cacheManager,
                     AuthenticationScheme authenticationScheme,
                     RequestAuthenticatorFactory requestAuthenticatorFactory,
                     int connectionTimeout)

Instantiates a new Client instance that will communicate with the Okta REST API. See the class-level JavaDoc for a usage example.

Parameters:

clientCredentialsResolver - Okta API Key resolver

baseUrlResolver - Okta base URL resolver

proxy - the HTTP proxy to be used when communicating with the Okta API server (can be null)

cacheManager - the CacheManager that should be used to cache Okta REST resources (can be null)

authenticationScheme - the HTTP authentication scheme to be used when communicating with the Okta API

requestAuthenticatorFactory -

connectionTimeout -

Method Detail

createApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps")
public Application createApplication(Application application,
                                                                                                                                                                                                        Boolean activate)

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)

Returns:

Application

createApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/apps")
public Application createApplication(Application application)

Add Application Adds a new application to your Okta organization.

Parameters:

application - (required)

Returns:

Application

createGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/groups")
public Group createGroup(Group group)

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

Parameters:

group - (required)

Returns:

Group

createRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/groups/rules")
public GroupRule createRule(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

createSession

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/sessions")
public Session createSession(CreateSessionRequest createSessionRequest)

Create Session with Session Token Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

Parameters:

createSessionRequest - (required)

Returns:

Session

createUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/users")
public User createUser(User body,
                                                                                                                                                                                           Boolean activate,
                                                                                                                                                                                           Boolean provider)

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)

Returns:

User

createUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="POST - /api/v1/users")
public User createUser(User body)

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

Parameters:

body - (required)

Returns:

User

getApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}")
public Application getApplication(String appId,
                                                                                                                                                                                                            String expand)

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

Parameters:

appId - (required)

expand - (optional)

Returns:

Application

getApplication

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps/{appId}")
public Application getApplication(String appId)

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

Parameters:

appId - (required)

Returns:

Application

getGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups/{groupId}")
public Group getGroup(String groupId,
                                                                                                                                                                                                    String expand)

List Group Rules Lists all group rules for your organization.

Parameters:

groupId - (required)

expand - (optional)

Returns:

Group

getGroup

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups/{groupId}")
public Group getGroup(String groupId)

List Group Rules Lists all group rules for your organization.

Parameters:

groupId - (required)

Returns:

Group

getLogs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/logs")
public LogEventList getLogs(String until,
                                                                                                                                                                                              String since,
                                                                                                                                                                                              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:

until - (optional)

since - (optional)

filter - (optional)

q - (optional)

sortOrder - (optional, default to ASCENDING)

Returns:

LogEventList

getLogs

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/logs")
public LogEventList getLogs()

Fetch a list of events from your Okta organization system log. The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API

Returns:

LogEventList

getRule

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups/rules/{ruleId}")
public GroupRule getRule(String ruleId)

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

Parameters:

ruleId - (required)

Returns:

GroupRule

getSession

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/sessions/{sessionId}")
public Session getSession(String sessionId)

Get details about a session.

Parameters:

sessionId - (required)

Returns:

Session

getUser

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/users/{userId}")
public User getUser(String userId)

Get User Fetches a user from your Okta organization.

Parameters:

userId - (required)

Returns:

User

listApplications

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps")
public ApplicationList listApplications(String q,
                                                                                                                                                                                                          String filter,
                                                                                                                                                                                                          String expand,
                                                                                                                                                                                                          Boolean includeNonDeleted)

List Applications Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Parameters:

q - (optional)

filter - Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)

expand - Traverses users link relationship and optionally embeds Application User resource (optional)

includeNonDeleted - (optional, default to false)

Returns:

ApplicationList

listApplications

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/apps")
public ApplicationList listApplications()

List Applications Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

Returns:

ApplicationList

listGroups

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups")
public GroupList listGroups(String q,
                                                                                                                                                                                                String filter,
                                                                                                                                                                                                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)

filter - Filter expression for groups (optional)

expand - (optional)

Returns:

GroupList

listGroups

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups")
public GroupList listGroups()

List Groups Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.

Returns:

GroupList

listRules

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/groups/rules")
public GroupRuleList listRules()

List Group Rules Lists all group rules for your organization.

Returns:

GroupRuleList

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/users")
public UserList listUsers(String q,
                                                                                                                                                                                             String filter,
                                                                                                                                                                                             String format,
                                                                                                                                                                                             String search,
                                                                                                                                                                                             String expand)

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)

format - (optional)

search - Searches for users with a supported filtering expression for most properties (optional)

expand - (optional)

Returns:

UserList

listUsers

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2017-12-14T13:01:44.308-05:00",
           comments="GET - /api/v1/users")
public UserList listUsers()

List Users Lists users in your organization with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.

Returns:

UserList