Principal Settings

The Principal Settings API allows admins to manage governance settings for a principal. Use this API to manage settings for a target principal, such as appointing a delegate for governance reviews.

Update the principal settings
Beta
OAuth 2.0 scopes:
  • okta.governance.settings.manage
Admin roles:
  • SUPER_ADMIN

Updates the settings for a principal

Request
path Parameters
targetPrincipalId
required
string

The id of the resource in Okta ID format or ORN format

Request Body schema: application/json
required
object

Delegates for the principal

Responses
200

A successful governance principal settings patch response

400

When governance settings fails as bad request

401

When authentication fails

403

When authorization fails

404

When the requested principal wasn't found

429

When the rate limit has been exceeded

500

When there is a server fault due to an unexpected error

patch/governance/api/v1/principal-settings/{targetPrincipalId}
Request samples
application/json
{
  • "delegates": {
    • "appointments": [
      • {
        }
      ]
    }
}
Response samples
application/json
{
  • "delegates": {
    • "appointments": [
      • {
        }
      ]
    }
}