Package com.okta.sdk.resource.api

Class SubscriptionApi

java.lang.Object

com.okta.sdk.resource.api.SubscriptionApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-29T16:46:27.777599-05:00[America/Chicago]",
           comments="Generator version: 7.4.0")
public class SubscriptionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SubscriptionApi()
SubscriptionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Subscription	getSubscriptionsNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)	Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified Role
Subscription	getSubscriptionsNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String,String> additionalHeaders)	Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified Role
Subscription	getSubscriptionsNotificationTypeUser(NotificationType notificationType, String userId)	Retrieve a Subscription for a User Retrieves a subscription by `notificationType` for a specified User.
Subscription	getSubscriptionsNotificationTypeUser(NotificationType notificationType, String userId, Map<String,String> additionalHeaders)	Retrieve a Subscription for a User Retrieves a subscription by `notificationType` for a specified User.
List<Subscription>	listSubscriptionsRole(ListSubscriptionsRoleRoleRefParameter roleRef)	List all Subscriptions for a Role Lists all subscriptions available to a specified Role
List<Subscription>	listSubscriptionsRole(ListSubscriptionsRoleRoleRefParameter roleRef, Map<String,String> additionalHeaders)	List all Subscriptions for a Role Lists all subscriptions available to a specified Role
List<Subscription>	listSubscriptionsUser(String userId)	List all Subscriptions for a User Lists all subscriptions available to a specified User.
List<Subscription>	listSubscriptionsUser(String userId, Map<String,String> additionalHeaders)	List all Subscriptions for a User Lists all subscriptions available to a specified User.
void	setApiClient(ApiClient apiClient)
void	subscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)	Subscribe a Role to a Specific Notification Type Subscribes a Role to a specified notification type.
void	subscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String,String> additionalHeaders)	Subscribe a Role to a Specific Notification Type Subscribes a Role to a specified notification type.
void	subscribeByNotificationTypeUser(NotificationType notificationType, String userId)	Subscribe a User to a Specific Notification Type Subscribes the current user to a specified notification type.
void	subscribeByNotificationTypeUser(NotificationType notificationType, String userId, Map<String,String> additionalHeaders)	Subscribe a User to a Specific Notification Type Subscribes the current user to a specified notification type.
void	unsubscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)	Unsubscribe a Role from a Specific Notification Type Unsubscribes a Role from a specified notification type.
void	unsubscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType, Map<String,String> additionalHeaders)	Unsubscribe a Role from a Specific Notification Type Unsubscribes a Role from a specified notification type.
void	unsubscribeByNotificationTypeUser(NotificationType notificationType, String userId)	Unsubscribe a User from a Specific Notification Type Unsubscribes the current user from a specified notification type.
void	unsubscribeByNotificationTypeUser(NotificationType notificationType, String userId, Map<String,String> additionalHeaders)	Unsubscribe a User from a Specific Notification Type Unsubscribes the current user from a specified notification type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubscriptionApi

public SubscriptionApi()

SubscriptionApi

public SubscriptionApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSubscriptionsNotificationTypeRole

public Subscription getSubscriptionsNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType)
                                                  throws ApiException

Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified Role

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getSubscriptionsNotificationTypeRole

public Subscription getSubscriptionsNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType,
 Map<String,String> additionalHeaders)
                                                  throws ApiException

Retrieve a Subscription for a Role Retrieves a subscription by `notificationType` for a specified Role

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getSubscriptionsNotificationTypeUser

public Subscription getSubscriptionsNotificationTypeUser(NotificationType notificationType,
 String userId)
                                                  throws ApiException

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

Parameters:

notificationType - (required)

userId - (required)

Returns:

Subscription

Throws:

ApiException - if fails to make API call

getSubscriptionsNotificationTypeUser

public Subscription getSubscriptionsNotificationTypeUser(NotificationType notificationType,
 String userId,
 Map<String,String> additionalHeaders)
                                                  throws ApiException

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

Parameters:

notificationType - (required)

userId - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Subscription

Throws:

ApiException - if fails to make API call

listSubscriptionsRole

public List<Subscription> listSubscriptionsRole(ListSubscriptionsRoleRoleRefParameter roleRef)
                                         throws ApiException

List all Subscriptions for a Role Lists all subscriptions available to a specified Role

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

Returns:

List<Subscription>

Throws:

ApiException - if fails to make API call

listSubscriptionsRole

public List<Subscription> listSubscriptionsRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 Map<String,String> additionalHeaders)
                                         throws ApiException

List all Subscriptions for a Role Lists all subscriptions available to a specified Role

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<Subscription>

Throws:

ApiException - if fails to make API call

listSubscriptionsUser

public List<Subscription> listSubscriptionsUser(String userId)
                                         throws ApiException

List all Subscriptions for a User Lists all subscriptions available to a specified User. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

userId - (required)

Returns:

List<Subscription>

Throws:

ApiException - if fails to make API call

listSubscriptionsUser

public List<Subscription> listSubscriptionsUser(String userId,
 Map<String,String> additionalHeaders)
                                         throws ApiException

List all Subscriptions for a User Lists all subscriptions available to a specified User. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

userId - (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<Subscription>

Throws:

ApiException - if fails to make API call

subscribeByNotificationTypeRole

public void subscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType)
                                     throws ApiException

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

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

Throws:

ApiException - if fails to make API call

subscribeByNotificationTypeRole

public void subscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType,
 Map<String,String> additionalHeaders)
                                     throws ApiException

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

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

subscribeByNotificationTypeUser

public void subscribeByNotificationTypeUser(NotificationType notificationType,
 String userId)
                                     throws ApiException

Subscribe a User to a Specific Notification Type Subscribes the current user to a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

notificationType - (required)

userId - (required)

Throws:

ApiException - if fails to make API call

subscribeByNotificationTypeUser

public void subscribeByNotificationTypeUser(NotificationType notificationType,
 String userId,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Subscribe a User to a Specific Notification Type Subscribes the current user to a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

notificationType - (required)

userId - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

unsubscribeByNotificationTypeRole

public void unsubscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType)
                                       throws ApiException

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

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

Throws:

ApiException - if fails to make API call

unsubscribeByNotificationTypeRole

public void unsubscribeByNotificationTypeRole(ListSubscriptionsRoleRoleRefParameter roleRef,
 NotificationType notificationType,
 Map<String,String> additionalHeaders)
                                       throws ApiException

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

Parameters:

roleRef - A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Role Types](https://developer.okta.com/docs/concepts/role-assignment/#standard-role-types). (required)

notificationType - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

unsubscribeByNotificationTypeUser

public void unsubscribeByNotificationTypeUser(NotificationType notificationType,
 String userId)
                                       throws ApiException

Unsubscribe a User from a Specific Notification Type Unsubscribes the current user from a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

notificationType - (required)

userId - (required)

Throws:

ApiException - if fails to make API call

unsubscribeByNotificationTypeUser

public void unsubscribeByNotificationTypeUser(NotificationType notificationType,
 String userId,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Unsubscribe a User from a Specific Notification Type Unsubscribes the current user from a specified notification type. Returns an `AccessDeniedException` message if requests are made for another user.

Parameters:

notificationType - (required)

userId - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()