Org Support Settings

The Org Support Settings API provides operations to manage the support settings for your Okta org.

Retrieve Okta Aerial consent for your Org
Early Access
OAuth 2.0: okta.orgs.manage

Retrieves the Okta Aerial consent grant details for your Org. Returns a 404 Not Found error if no consent has been granted.

Responses
200

Success

400

Can't complete request due to errors

403

Forbidden

404

Consent hasn't been given and there are no grants to any Aerial Accounts

429

Too Many Requests

get/api/v1/org/privacy/aerial
Request samples 
Response samples 
application/json
Example response of consent details


{
  • "accountId": "0200bs0617vvhv2v675mch1cukp",
  • "grantDate": "2023-04-06T21:32:33.000Z",
  • "grantedBy": "00uabcdefg1234567890"
}
Grant Okta Aerial access to your Org
Early Access
OAuth 2.0: okta.orgs.manage
Grants an Okta Aerial account access to your Org. If the org is a child org, consent is taken from the parent org.  Grant calls directly to the child are not allowed.


Request 
Request Body schema: application/json
accountId
required
string
The unique ID of the Aerial account


 
Responses 
200
Success


400
Can't complete request due to errors


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/aerial/grant
Request samples 
application/json
Request body to grant an Okta Aerial account access to your Org


{
  • "accountId": "0200bs0617vvhv2v675mch1cukp"
}
Response samples 
application/json
Example response of consent details


{
  • "accountId": "0200bs0617vvhv2v675mch1cukp",
  • "grantDate": "2023-04-06T21:32:33.000Z",
  • "grantedBy": "00uabcdefg1234567890"
}
Revoke Okta Aerial access to your Org
Early Access
OAuth 2.0: okta.orgs.manage
Revokes access of an Okta Aerial account to your Org. The revoke operation will fail if the org has already been added to an Aerial account.


Request 
Request Body schema: application/json
accountId
required
string
The unique ID of the Aerial account


 
Responses 
200
Success


400
Can't complete request due to errors


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/aerial/revoke
Request samples 
application/json
Request body for revoking an Okta Aerial account


{
  • "accountId": "0200bs0617vvhv2v675mch1cukp"
}
Response samples 
application/json
{
  • "_links": {
    • "grant": {
      }
    }
}
Retrieve the Okta Support Settings
OAuth 2.0: okta.orgs.read
Retrieves Okta Support Settings for your org


Responses 
200
Success


403
Forbidden


429
Too Many Requests


get/api/v1/org/privacy/oktaSupport
Request samples 
Response samples 
application/json
{}
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
{}
Grant Okta Support Access
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
{}
Revoke Okta Support Access
OAuth 2.0: okta.orgs.manage
Revokes Okta Support access to your org


Responses 
200
Success


403
Forbidden


429
Too Many Requests


post/api/v1/org/privacy/oktaSupport/revoke
Request samples 
Response samples 
application/json
{}