7.0 KiB
7.0 KiB
name, description
| name | description |
|---|---|
| org-routes | Handle 31 OpenAPI operation(s) under /api/v1/org for the org route group. |
org API Routes
Handle 31 OpenAPI operation(s) under /api/v1/org for the org route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_org_settings
- Operation ID:
get_org_settings - Route:
GET /api/v1/org - Mode: READ
- Summary: Retrieve the Org general settings
update_org_settings
- Operation ID:
update_org_settings - Route:
POST /api/v1/org - Mode: WRITE
- Summary: Update the Org general settings
- Body: JSON request body accepted.
replace_org_settings
- Operation ID:
replace_org_settings - Route:
PUT /api/v1/org - Mode: WRITE
- Summary: Replace the Org general settings
- Body: JSON request body accepted.
get_org_captcha_settings
- Operation ID:
get_org_captcha_settings - Route:
GET /api/v1/org/captcha - Mode: READ
- Summary: Retrieve the org-wide CAPTCHA settings
replaces_org_captcha_settings
- Operation ID:
replaces_org_captcha_settings - Route:
PUT /api/v1/org/captcha - Mode: WRITE
- Summary: Replace the org-wide CAPTCHA settings
- Body: JSON request body accepted.
delete_org_captcha_settings
- Operation ID:
delete_org_captcha_settings - Route:
DELETE /api/v1/org/captcha - Mode: WRITE
- Summary: Delete the org-wide CAPTCHA settings
list_org_contact_types
- Operation ID:
list_org_contact_types - Route:
GET /api/v1/org/contacts - Mode: READ
- Summary: List all org contact types
get_org_contact_user
- Operation ID:
get_org_contact_user - Route:
GET /api/v1/org/contacts/{contactType} - Mode: READ
- Summary: Retrieve the contact type user
- Parameters:
contactTypeinpathrequired
replace_org_contact_user
- Operation ID:
replace_org_contact_user - Route:
PUT /api/v1/org/contacts/{contactType} - Mode: WRITE
- Summary: Replace the contact type user
- Parameters:
contactTypeinpathrequired
- Body: JSON request body accepted.
bulk_remove_email_address_bounces
- Operation ID:
bulk_remove_email_address_bounces - Route:
POST /api/v1/org/email/bounces/remove-list - Mode: WRITE
- Summary: Remove bounced emails
- Body: JSON request body accepted.
list_yubikey_otp_tokens
- Operation ID:
list_yubikey_otp_tokens - Route:
GET /api/v1/org/factors/yubikey_token/tokens - Mode: READ
- Summary: List all YubiKey OTP tokens
- Parameters:
afterinqueryexpandinqueryfilterinqueryforDownloadinquerylimitinquerysortByinquerysortOrderinquery
upload_yubikey_otp_token_seed
- Operation ID:
upload_yubikey_otp_token_seed - Route:
POST /api/v1/org/factors/yubikey_token/tokens - Mode: WRITE
- Summary: Upload a YubiKey OTP seed
- Parameters:
afterinqueryexpandinqueryfilterinqueryforDownloadinquerylimitinquerysortByinquerysortOrderinquery
- Body: JSON request body accepted.
get_yubikey_otp_token_by_id
- Operation ID:
get_yubikey_otp_token_by_id - Route:
GET /api/v1/org/factors/yubikey_token/tokens/{tokenId} - Mode: READ
- Summary: Retrieve a YubiKey OTP token
- Parameters:
tokenIdinpathrequired
get_third_party_admin_setting
- Operation ID:
get_third_party_admin_setting - Route:
GET /api/v1/org/orgSettings/thirdPartyAdminSetting - Mode: READ
- Summary: Retrieve the org third-party admin setting
update_third_party_admin_setting
- Operation ID:
update_third_party_admin_setting - Route:
POST /api/v1/org/orgSettings/thirdPartyAdminSetting - Mode: WRITE
- Summary: Update the org third-party admin setting
- Body: JSON request body accepted.
get_org_preferences
- Operation ID:
get_org_preferences - Route:
GET /api/v1/org/preferences - Mode: READ
- Summary: Retrieve the org preferences
set_org_hide_okta_ui_footer
- Operation ID:
set_org_hide_okta_ui_footer - Route:
POST /api/v1/org/preferences/hideEndUserFooter - Mode: WRITE
- Summary: Set the hide dashboard footer preference
set_org_show_okta_ui_footer
- Operation ID:
set_org_show_okta_ui_footer - Route:
POST /api/v1/org/preferences/showEndUserFooter - Mode: WRITE
- Summary: Set the show dashboard footer preference
get_aerial_consent
- Operation ID:
get_aerial_consent - Route:
GET /api/v1/org/privacy/aerial - Mode: READ
- Summary: Retrieve Okta Aerial consent for your org
grant_aerial_consent
- Operation ID:
grant_aerial_consent - Route:
POST /api/v1/org/privacy/aerial/grant - Mode: WRITE
- Summary: Grant Okta Aerial access to your org
- Body: JSON request body accepted.
revoke_aerial_consent
- Operation ID:
revoke_aerial_consent - Route:
POST /api/v1/org/privacy/aerial/revoke - Mode: WRITE
- Summary: Revoke Okta Aerial access to your org
- Body: JSON request body accepted.
get_okta_communication_settings
- Operation ID:
get_okta_communication_settings - Route:
GET /api/v1/org/privacy/oktaCommunication - Mode: READ
- Summary: Retrieve the Okta communication settings
opt_in_users_to_okta_communication_emails
- Operation ID:
opt_in_users_to_okta_communication_emails - Route:
POST /api/v1/org/privacy/oktaCommunication/optIn - Mode: WRITE
- Summary: Opt in to Okta user communication emails
opt_out_users_from_okta_communication_emails
- Operation ID:
opt_out_users_from_okta_communication_emails - Route:
POST /api/v1/org/privacy/oktaCommunication/optOut - Mode: WRITE
- Summary: Opt out of Okta user communication emails
get_org_okta_support_settings
- Operation ID:
get_org_okta_support_settings - Route:
GET /api/v1/org/privacy/oktaSupport - Mode: READ
- Summary: Retrieve the Okta Support settings
list_okta_support_cases
- Operation ID:
list_okta_support_cases - Route:
GET /api/v1/org/privacy/oktaSupport/cases - Mode: READ
- Summary: List all Okta Support cases
update_okta_support_case
- Operation ID:
update_okta_support_case - Route:
PATCH /api/v1/org/privacy/oktaSupport/cases/{caseNumber} - Mode: WRITE
- Summary: Update an Okta Support case
- Parameters:
caseNumberinpathrequired
- Body: JSON request body accepted.
extend_okta_support
- Operation ID:
extend_okta_support - Route:
POST /api/v1/org/privacy/oktaSupport/extend - Mode: WRITE
- Summary: Extend Okta Support access
grant_okta_support
- Operation ID:
grant_okta_support - Route:
POST /api/v1/org/privacy/oktaSupport/grant - Mode: WRITE
- Summary: Grant Okta Support access
revoke_okta_support
- Operation ID:
revoke_okta_support - Route:
POST /api/v1/org/privacy/oktaSupport/revoke - Mode: WRITE
- Summary: Revoke Okta Support access
get_auto_assign_admin_app_setting
- Operation ID:
get_auto_assign_admin_app_setting - Route:
GET /api/v1/org/settings/autoAssignAdminAppSetting - Mode: READ
- Summary: Retrieve the Okta Admin Console assignment setting