subscriptions

Creates, updates, deletes, gets or lists a subscriptions resource.

Overview

Name	subscriptions
Type	Resource
Id	okta.roles.subscriptions

Fields

The following fields are returned by SELECT queries:

get_subscriptions_notification_type_role

Name	Datatype	Description
_links	object	Discoverable resources related to the subscription
channels	array	An array of sources send notifications to users. > Note: Currently, Okta only allows email channels.
notificationType	string	The type of notification (AD_AGENT, AGENT_AUTO_UPDATE_NOTIFICATION, AGENT_AUTO_UPDATE_NOTIFICATION_LDAP, APP_IMPORT, CONNECTOR_AGENT, IWA_AGENT, LDAP_AGENT, OKTA_ANNOUNCEMENT, OKTA_UPDATE, RATELIMIT_NOTIFICATION, REPORT_SUSPICIOUS_ACTIVITY, USER_DEPROVISION, USER_LOCKED_OUT)
status	string	The status of the subscription (subscribed, unsubscribed)

list_subscriptions_role

Name	Datatype	Description
_links	object	Discoverable resources related to the subscription
channels	array	An array of sources send notifications to users. > Note: Currently, Okta only allows email channels.
notificationType	string	The type of notification (AD_AGENT, AGENT_AUTO_UPDATE_NOTIFICATION, AGENT_AUTO_UPDATE_NOTIFICATION_LDAP, APP_IMPORT, CONNECTOR_AGENT, IWA_AGENT, LDAP_AGENT, OKTA_ANNOUNCEMENT, OKTA_UPDATE, RATELIMIT_NOTIFICATION, REPORT_SUSPICIOUS_ACTIVITY, USER_DEPROVISION, USER_LOCKED_OUT)
status	string	The status of the subscription (subscribed, unsubscribed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_subscriptions_notification_type_role	select	roleRef, notificationType, subdomain		Retrieves a subscription by notificationType for a specified Role
list_subscriptions_role	select	roleRef, subdomain		Lists all subscriptions available to a specified Role
subscribe_by_notification_type_role	exec	roleRef, notificationType, subdomain		Subscribes a Role to a specified notification type. Changes to Role subscriptions override the subscription status of any individual users with the Role.
unsubscribe_by_notification_type_role	exec	roleRef, notificationType, subdomain		Unsubscribes a Role from a specified notification type. Changes to Role subscriptions override the subscription status of any individual users with the Role.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
notificationType	string
roleRef		A reference to an existing role. Standard roles require a roleType, while Custom Roles require a roleId. See Standard roles.
subdomain	string	(default: my-org)

SELECT examples

get_subscriptions_notification_type_role

Retrieves a subscription by notificationType for a specified Role

SELECT
_links,
channels,
notificationType,
status
FROM okta.roles.subscriptions
WHERE roleRef = '{{ roleRef }}' -- required
AND notificationType = '{{ notificationType }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_subscriptions_role

Lists all subscriptions available to a specified Role

SELECT
_links,
channels,
notificationType,
status
FROM okta.roles.subscriptions
WHERE roleRef = '{{ roleRef }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

Lifecycle Methods

subscribe_by_notification_type_role

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

EXEC okta.roles.subscriptions.subscribe_by_notification_type_role 
@roleRef='{{ roleRef }}' --required, 
@notificationType='{{ notificationType }}' --required, 
@subdomain='{{ subdomain }}' --required
;

unsubscribe_by_notification_type_role

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

EXEC okta.roles.subscriptions.unsubscribe_by_notification_type_role 
@roleRef='{{ roleRef }}' --required, 
@notificationType='{{ notificationType }}' --required, 
@subdomain='{{ subdomain }}' --required
;