Org Admin Settings

The Org Admin Settings API provides operations to manage the admin settings for your Okta org.

Retrieve the org third-party admin setting
OAuth 2.0 scopes:
  • okta.orgs.read

Retrieves the third-party admin setting. See Configure third-party administrators in the Okta product documentation.

Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/org/orgSettings/thirdPartyAdminSetting
Request samples 
Response samples 
application/json
{
  • "thirdPartyAdmin": false
}
Update the org third-party admin setting
OAuth 2.0 scopes: 
  • okta.orgs.manage
Updates the third-party admin setting.
This setting allows third-party admins to perform administrative actions in the Admin Console, but they can't do any of the following:


    

  • Receive Okta admin email notifications
    • 

  • Contact Okta support
    • 

  • Sign in to the Okta Help Center
    • 



See Configure third-party administrators in the Okta product documentation.


Request 
Request Body schema: application/json
required
thirdPartyAdmin
boolean
Indicates if the third-party admin functionality is enabled


 
Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/orgSettings/thirdPartyAdminSetting
Request samples 
application/json
{
  • "thirdPartyAdmin": false
}
Response samples 
application/json
{
  • "thirdPartyAdmin": false
}
Retrieve the Okta Admin Console assignment setting
OAuth 2.0 scopes: 
  • okta.orgs.read
Retrieves the org setting to automatically assign the Okta Admin Console when an admin role is assigned


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/settings/autoAssignAdminAppSetting
Request samples 
Response samples 
application/json
{
  • "autoAssignAdminAppSetting": true
}
Update the Okta Admin Console assignment setting
OAuth 2.0 scopes: 
  • okta.orgs.manage
Updates the org setting to automatically assign the Okta Admin Console when an admin role is assigned




Note: This setting doesn't apply to the SUPER_ADMIN role.
When you assign the SUPER_ADMIN role to a user, the Admin Console is always assigned to the user regardless of the autoAssignAdminAppSetting setting.




Request 
Request Body schema: application/json
autoAssignAdminAppSetting
boolean
Automatically assigns the Okta Admin Console to the user when an admin role is assigned


 
Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/settings/autoAssignAdminAppSetting
Request samples 
application/json
{
  • "autoAssignAdminAppSetting": true
}
Response samples 
application/json
{
  • "autoAssignAdminAppSetting": true
}
Retrieve the default public client app role setting
OAuth 2.0 scopes: 
  • okta.orgs.read
Retrieves the org setting to assign the Super Admin role to new public client apps


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/settings/clientPrivilegesSetting
Request samples 
Response samples 
application/json
{
  • "clientPrivilegesSetting": true
}
Assign the default public client app role setting
OAuth 2.0 scopes: 
  • okta.orgs.manage
Assigns the Super Admin role as the default role for new public client apps


Request 
Request Body schema: application/json
clientPrivilegesSetting
boolean
If true, assigns the super admin role by default to new public client apps


 
Responses 
200
Success


403
Forbidden


429
Too Many Requests


put/api/v1/org/settings/clientPrivilegesSetting
Request samples 
application/json
{
  • "clientPrivilegesSetting": true
}
Response samples 
application/json
{
  • "clientPrivilegesSetting": true
}