Skip to content

Retrieve a subscription for a user

Request

OAuth 2.0 scope:
  • okta.users.read

Retrieves a subscription by notificationType for a specified user. Returns an AccessDeniedException message if requests are made for another user.

Path
userIdstringrequired

The unique ID of the user

notificationTypestring(NotificationType)required

The type of notification

Enum ValueDescription
AD_AGENT

System notification sent when an AD agent disconnects or reconnects

AGENT_AUTO_UPDATE_NOTIFICATION

System notification sent when an agent automatically updates

APP_IMPORT

System notification sent with the status of an app user import

CONNECTOR_AGENT

System notification sent when an on-premises provisioning or Okta on-prem MFA agent disconnects or reconnects

IWA_AGENT

System notification sent when an IGA agent disconnects or reconnects

LDAP_AGENT

System notification sent when an LDAP agent disconnects or reconnects

OKTA_ANNOUNCEMENT

Okta communication sent for announcements and release notes

OKTA_UPDATE

Okta communication sent for scheduled system updates

RATELIMIT_NOTIFICATION

System notification sent when an org reaches rate limit warning or violation thresholds

REPORT_SUSPICIOUS_ACTIVITY

System notification sent when a user reports suspicious activity

USER_DEPROVISION

System notification sent when a user is deprovisioned from apps

USER_LOCKED_OUT

System notification sent when a user is locked out from logging in to Okta

curl -i -X GET \
  'https://subdomain.okta.com/api/v1/users/{userId}/subscriptions/{notificationType}'

Responses

Success

Bodyapplication/json
channelsArray of strings

An array of sources send notifications to users.

Note: Currently, Okta only allows email channels.

notificationTypestring(NotificationType)

The type of notification

Enum ValueDescription
AD_AGENT

System notification sent when an AD agent disconnects or reconnects

AGENT_AUTO_UPDATE_NOTIFICATION

System notification sent when an agent automatically updates

APP_IMPORT

System notification sent with the status of an app user import

CONNECTOR_AGENT

System notification sent when an on-premises provisioning or Okta on-prem MFA agent disconnects or reconnects

IWA_AGENT

System notification sent when an IGA agent disconnects or reconnects

LDAP_AGENT

System notification sent when an LDAP agent disconnects or reconnects

OKTA_ANNOUNCEMENT

Okta communication sent for announcements and release notes

OKTA_UPDATE

Okta communication sent for scheduled system updates

RATELIMIT_NOTIFICATION

System notification sent when an org reaches rate limit warning or violation thresholds

REPORT_SUSPICIOUS_ACTIVITY

System notification sent when a user reports suspicious activity

USER_DEPROVISION

System notification sent when a user is deprovisioned from apps

USER_LOCKED_OUT

System notification sent when a user is locked out from logging in to Okta

statusstring(SubscriptionStatus)

The status of the subscription

Enum:"subscribed""unsubscribed"
Response
{ "channels": [ "string" ], "notificationType": "AD_AGENT", "status": "subscribed", "_links": { "self": { … } } }