Okta Application Settings

The Okta Application Settings API provides operations to manage settings for Okta apps in your org.

Retrieve the Okta Application Settings
OAuth 2.0: okta.apps.read

Retrieves the settings for an Okta app (also known as an Okta first-party app)

Request
path Parameters
appName
required
string

The key name for the Okta app.
Supported apps:

  • Okta Admin Console (admin-console)
Example: admin-console
Responses
200

OK

403

Forbidden

429

Too Many Requests

get/api/v1/first-party-app-settings/{appName}
Request samples
Response samples
application/json
{
  • "sessionMaxLifetimeMinutes": 720,
  • "sessionIdleTimeoutMinutes": 15
}

Replace the Okta Application Settings
OAuth 2.0: okta.apps.manage

Replaces the settings for an Okta app (also known as an Okta first-party app)

Request
path Parameters
appName
required
string

The key name for the Okta app.
Supported apps:

  • Okta Admin Console (admin-console)
Example: admin-console
Request Body schema: application/json
required
sessionIdleTimeoutMinutes
integer [ 5 .. 720 ]
Default: 15

The maximum idle time before the Okta Admin Console session expires. Must be no more than 12 hours.

sessionMaxLifetimeMinutes
integer [ 5 .. 10080 ]
Default: 720

The absolute maximum session lifetime of the Okta Admin Console. Must be no more than 7 days.

Responses
200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

put/api/v1/first-party-app-settings/{appName}
Request samples
application/json
{
  • "sessionMaxLifetimeMinutes": 720,
  • "sessionIdleTimeoutMinutes": 15
}
Response samples
application/json
{
  • "sessionMaxLifetimeMinutes": 720,
  • "sessionIdleTimeoutMinutes": 15
}