Org Settings

The Org Settings API provides operations to manage your org account settings such as contact information, granting Okta Support access, and more.

Retrieve the Well-Known Org Metadata
CORS

Retrieves the well-known org metadata, which includes the id, configured custom domains, authentication pipeline, and various other org settings

Responses
200

Success

429

Too Many Requests

get/.well-known/okta-organization
Request samples 
Response samples 
application/json
{}
Retrieve the Org Settings
OAuth 2.0: okta.orgs.read
Retrieves the org settings


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org
Request samples 
Response samples 
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "companyName": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "endUserSupportHelpURL": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "state": "string",
  • "status": "string",
  • "subdomain": "string",
  • "supportPhoneNumber": "string",
  • "website": "string",
  • "_links": {
    • "self": {
      }
    }
}
Update the Org Settings
OAuth 2.0: okta.orgs.manage
Partially updates the org settings depending on provided fields


Request 
Request Body schema: application/json
address1
string
 
address2
string
 
city
string
 
companyName
string
 
country
string
 
endUserSupportHelpURL
string
 
phoneNumber
string
 
postalCode
string
 
state
string
 
supportPhoneNumber
string
 
website
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


post/api/v1/org
Request samples 
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "companyName": "string",
  • "country": "string",
  • "endUserSupportHelpURL": "string",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "state": "string",
  • "supportPhoneNumber": "string",
  • "website": "string"
}
Response samples 
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "companyName": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "endUserSupportHelpURL": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "state": "string",
  • "status": "string",
  • "subdomain": "string",
  • "supportPhoneNumber": "string",
  • "website": "string",
  • "_links": {
    • "self": {
      }
    }
}
Replace the Org Settings
OAuth 2.0: okta.orgs.manage
Replaces the settings of your organization


Request 
Request Body schema: application/json
required
address1
string
 
address2
string
 
city
string
 
companyName
string
 
country
string
 
endUserSupportHelpURL
string
 
phoneNumber
string
 
postalCode
string
 
state
string
 
supportPhoneNumber
string
 
website
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


put/api/v1/org
Request samples 
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "companyName": "string",
  • "country": "string",
  • "endUserSupportHelpURL": "string",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "state": "string",
  • "supportPhoneNumber": "string",
  • "website": "string"
}
Response samples 
application/json
{
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "companyName": "string",
  • "country": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "endUserSupportHelpURL": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "phoneNumber": "string",
  • "postalCode": "string",
  • "state": "string",
  • "status": "string",
  • "subdomain": "string",
  • "supportPhoneNumber": "string",
  • "website": "string",
  • "_links": {
    • "self": {
      }
    }
}
Retrieve the Org Contact Types
OAuth 2.0: okta.orgs.read
Retrieves Contact Types of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/contacts
Request samples 
Response samples 
application/json
[
  • {
    • "contactType": "BILLING",
    • "_links": {
      }
    }
]
Retrieve the User of the Contact Type
OAuth 2.0: okta.orgs.read
Retrieves the URL of the User associated with the specified Contact Type


Request 
path Parameters
contactType
required
string
 
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/org/contacts/{contactType}
Request samples 
Response samples 
application/json
{
  • "userId": "string",
  • "_links": {
    • "self": {
      }
    }
}
Replace the User of the Contact Type
OAuth 2.0: okta.orgs.manage
Replaces the User associated with the specified Contact Type


Request 
path Parameters
contactType
required
string
 
Request Body schema: application/json
required
userId
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/org/contacts/{contactType}
Request samples 
application/json
{
  • "userId": "string"
}
Response samples 
application/json
{
  • "userId": "string",
  • "_links": {
    • "self": {
      }
    }
}
Remove Emails from Email Provider Bounce List
OAuth 2.0: okta.orgs.manage
Removes a list of email addresses to be removed from the set of email addresses that are bounced


Request 
Request Body schema: application/json
emailAddresses
Array of strings
 
Responses 
200
Deletes the provided list of emails from the set of email addresses that are bounced so that the provider resumes sending emails to those addresses.


400
Bad Request


403
Forbidden


429
Too Many Requests


post/api/v1/org/email/bounces/remove-list
Request samples 
application/json
{
  • "emailAddresses": [
    • "name@company.com",
    • "unknown.email@okta.com",
    • "name@okta@com"
    ]
}
Response samples 
application/json
{
  • "errors": [
    • {
      },
    • {
      }
    ]
}
Retrieve the Org Third-Party Admin setting
OAuth 2.0: okta.orgs.read
Retrieves the Third-Party Admin setting


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/orgSettings/thirdPartyAdminSetting
Request samples 
Response samples 
application/json
{
  • "thirdPartyAdmin": true
}
Update the Org Third-Party Admin setting
OAuth 2.0: okta.orgs.manage
Updates the Third-Party Admin setting


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/orgSettings/thirdPartyAdminSetting
Request samples 
Response samples 
application/json
{
  • "thirdPartyAdmin": true
}
Retrieve the Org Preferences
OAuth 2.0: okta.orgs.read
Retrieves preferences of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/preferences
Request samples 
Response samples 
application/json
{
  • "showEndUserFooter": true,
  • "_links": {
    • "self": {
      }
    }
}
Update the Preference to Hide the Okta Dashboard Footer
OAuth 2.0: okta.orgs.manage
Updates the preference hide the Okta UI footer for all end users of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/preferences/hideEndUserFooter
Request samples 
Response samples 
application/json
{
  • "showEndUserFooter": true,
  • "_links": {
    • "self": {
      }
    }
}
Update the Preference to Show the Okta Dashboard Footer
OAuth 2.0: okta.orgs.manage
Updates the preference to show the Okta UI footer for all end users of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/preferences/showEndUserFooter
Request samples 
Response samples 
application/json
{
  • "showEndUserFooter": true,
  • "_links": {
    • "self": {
      }
    }
}
Retrieve the Okta Communication Settings
OAuth 2.0: okta.orgs.read
Retrieves Okta Communication Settings of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/privacy/oktaCommunication
Request samples 
Response samples 
application/json
{
  • "optOutEmailUsers": true,
  • "_links": {
    • "self": {
      }
    }
}
Opt in all Users to Okta Communication emails
OAuth 2.0: okta.orgs.manage
Opts in all users of this org to Okta Communication emails


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaCommunication/optIn
Request samples 
Response samples 
application/json
{
  • "optOutEmailUsers": true,
  • "_links": {
    • "self": {
      }
    }
}
Opt out all Users from Okta Communication emails
OAuth 2.0: okta.orgs.manage
Opts out all users of this org from Okta Communication emails


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaCommunication/optOut
Request samples 
Response samples 
application/json
{
  • "optOutEmailUsers": true,
  • "_links": {
    • "self": {
      }
    }
}
Retrieve the Okta Support Settings
OAuth 2.0: okta.orgs.read
Retrieves Okta Support Settings of your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/privacy/oktaSupport
Request samples 
Response samples 
application/json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "support": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Extend Okta Support Access
OAuth 2.0: okta.orgs.manage
Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaSupport/extend
Request samples 
Response samples 
application/json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "support": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Grant Okta Support Access to your Org
OAuth 2.0: okta.orgs.manage
Grants Okta Support temporary access your org as an administrator for eight hours


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaSupport/grant
Request samples 
Response samples 
application/json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "support": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Revoke Okta Support Access
OAuth 2.0: okta.orgs.manage
Revokes Okta Support access to your organization


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaSupport/revoke
Request samples 
Response samples 
application/json
{
  • "expiration": "2019-08-24T14:15:22Z",
  • "support": "DISABLED",
  • "_links": {
    • "self": {
      }
    }
}
Retrieve the Org settings to assign the Super Admin role
OAuth 2.0: okta.orgs.read
Retrieves the Org settings to assign the Super Admin role by default to a public client app


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 Super Admin role to a public client app
OAuth 2.0: okta.orgs.manage
Assigns the Super Admin role by default to a public client app


Request 
Request Body schema: application/json
clientPrivilegesSetting
boolean
 
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
}