Governance

Endpoints to retrieve data related to Okta Identity Governance

List access request condition templates
Early Access
OAuth 2.0 scopes:
  • okta.accounts.read

Lists all access request condition templates

SecurityOAuth2
Request
path Parameters
accountId
required
string

The id of the Aerial account

query Parameters
filter
string

A SCIM 2.0 filter expression that filters the results.

Examples:
filter=applyStatus eq "APPLIED"
Responses
200

Success

401

Unauthorized

403

Forbidden

404

Resource Not Found

429

Rate limit exceeded

500

Internal Server Error

get/{accountId}/governance/api/v1/request-condition-templates
Request samples
Response samples
application/json
{
  • "data": [
    • {
      }
    ]
}

Retrieve an access request condition template
Early Access
OAuth 2.0 scopes:
  • okta.accounts.read

Retrieves an access request condition template by templateId

SecurityOAuth2
Request
path Parameters
accountId
required
string

The id of the Aerial account

templateId
required
string

The id of the access request condition template

Responses
200

Success

401

Unauthorized

403

Forbidden

404

Resource Not Found

429

Rate limit exceeded

500

Internal Server Error

get/{accountId}/governance/api/v1/request-condition-templates/{templateId}
Request samples
Response samples
application/json
{
  • "id": "020qqli3iolphlqkmrutpt8271c",
  • "applyStatus": "APPLIED",
  • "resources": [
    • "orn:okta:accounts:0227mkkf8ulgt48bkidcd8ekqft:orgs"
    ],
  • "requestCondition": {
    • "$ref": "../../../specs/governance/spec/v2-request-conditions/resources/models/creatable/examples/request-condition-creatable-15-entitlement-bundle-access-scope-everyone-fixed-duration.yaml"
    }
}

Apply an access request condition
Early Access
OAuth 2.0 scopes:
  • okta.accounts.manage

Asynchronously applies an access request condition template to the Aerial connection apps for managed orgs, and sets the template to the APPLYING status. The result can be checked by a GET request to /{accountId}/governance/api/v1/request-condition-templates/{templateId}. The endpoint can be called when a template has a status of NOT_APPLIED, APPLIED, or ERROR to re-apply template. If an Aerial connection app for a managed org already has a manually created access request condition, it will be overwritten when the template is applied.

SecurityOAuth2
Request
path Parameters
accountId
required
string

The id of the Aerial account

templateId
required
string

The id of the access request condition template

Responses
200

An empty object reserved for future use

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource Not Found

429

Rate limit exceeded

500

Internal Server Error

post/{accountId}/governance/api/v1/request-condition-templates/{templateId}/apply
Request samples
Response samples
application/json
{
  • "Success": { }
}

Remove an access request condition
Early Access
OAuth 2.0 scopes:
  • okta.accounts.manage

Deactivates and removes an access request condition template from its associated resources. It can be called when a template has a status of APPLIED or ERROR.

SecurityOAuth2
Request
path Parameters
accountId
required
string

The id of the Aerial account

templateId
required
string

The id of the access request condition template

Responses
200

An empty object reserved for future use

400

Bad Request

401

Unauthorized

403

Forbidden

404

Resource Not Found

429

Rate limit exceeded

500

Internal Server Error

post/{accountId}/governance/api/v1/request-condition-templates/{templateId}/remove
Request samples
Response samples
application/json
{
  • "Success": { }
}