POST /api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribe

Unsubscribes a Role from a specified notification type. Changes to Role subscriptions override the subscription status of any individual users with the Role.

Servers

Path parameters

Name Type Required Description
roleRef Yes

A reference to an existing role. Standard roles require a roleType, while Custom Roles require a roleId. See Standard Roles.

notificationType String Yes

Possible values:

  • "AGENT_AUTO_UPDATE_NOTIFICATION"
  • "AD_AGENT"
  • "USER_LOCKED_OUT"
  • "AGENT_AUTO_UPDATE_NOTIFICATION_LDAP"
  • "IWA_AGENT"
  • "RATELIMIT_NOTIFICATION"
  • "USER_DEPROVISION"
  • "REPORT_SUSPICIOUS_ACTIVITY"
  • "OKTA_UPDATE"
  • "LDAP_AGENT"
  • "OKTA_ISSUE"
  • "CONNECTOR_AGENT"
  • "APP_IMPORT"
  • "OKTA_ANNOUNCEMENT"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.