com.okta.sdk.resource.role

Interface Subscription

All Superinterfaces:

ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Implementing Classes:

DefaultSubscription

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface Subscription
extends ExtensibleResource

Subscription

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
List<String>	getChannels()
Map<String,Object>	getLinks()
NotificationType	getNotificationType()
Subscription	getRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Get subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type.
SubscriptionStatus	getStatus()
Subscription	getUserSubscriptionByNotificationType(String userId, String notificationType) Get the subscription of a User with a specific notification type Get the subscriptions of a User with a specific notification type.
SubscriptionList	listRoleSubscriptions(String roleTypeOrRoleId) List all subscriptions of a Custom Role When roleType List all subscriptions of a Role.
SubscriptionList	listUserSubscriptions(String userId) List subscriptions of a User List subscriptions of a User.
Subscription	setChannels(List<String> channels)
Subscription	setNotificationType(NotificationType notificationType)
Subscription	setStatus(SubscriptionStatus status)
void	subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type.
void	subscribeUserSubscriptionByNotificationType(String userId, String notificationType) Subscribe to a specific notification type Subscribes a User to a specific notification type.
void	unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId, String notificationType) Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type.
void	unsubscribeUserSubscriptionByNotificationType(String userId, String notificationType) Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type.

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getLinks

Map<String,Object> getLinks()

getChannels

List<String> getChannels()

setChannels

Subscription setChannels(List<String> channels)

getNotificationType

NotificationType getNotificationType()

setNotificationType

Subscription setNotificationType(NotificationType notificationType)

getStatus

SubscriptionStatus getStatus()

setStatus

Subscription setStatus(SubscriptionStatus status)

getUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/subscriptions/{notificationType}")
Subscription getUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                               String notificationType)

Get the subscription of a User with a specific notification type Get the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

Parameters:

userId - (required)

notificationType - (required)

Returns:

Subscription

subscribeRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe")
void subscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                                  String notificationType)

Subscribe a Custom Role to a specific notification type When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

subscribeUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe")
void subscribeUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                                        String notificationType)

Subscribe to a specific notification type Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Parameters:

userId - (required)

notificationType - (required)

listRoleSubscriptions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions")
SubscriptionList listRoleSubscriptions(String roleTypeOrRoleId)

List all subscriptions of a Custom Role When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

Parameters:

roleTypeOrRoleId - (required)

Returns:

SubscriptionList

unsubscribeRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                                      String notificationType)

Unsubscribe a Custom Role from a specific notification type When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

getRoleSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}")
Subscription getRoleSubscriptionByNotificationType(String roleTypeOrRoleId,
                                                                                                                                                                                                                                                                         String notificationType)

Get subscriptions of a Custom Role with a specific notification type When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

Parameters:

roleTypeOrRoleId - (required)

notificationType - (required)

Returns:

Subscription

unsubscribeUserSubscriptionByNotificationType

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeUserSubscriptionByNotificationType(String userId,
                                                                                                                                                                                                                                                                            String notificationType)

Unsubscribe from a specific notification type Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

Parameters:

userId - (required)

notificationType - (required)

listUserSubscriptions

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="GET - /api/v1/users/{userId}/subscriptions")
SubscriptionList listUserSubscriptions(String userId)

List subscriptions of a User List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

Parameters:

userId - (required)

Returns:

SubscriptionList