Package com.okta.sdk.resource.role

Interface Subscription

    • Method Detail

      • getLinks

        java.util.Map<java.lang.String,​java.lang.Object> getLinks()

      • getChannels

        java.util.List<java.lang.String> getChannels()

      • setChannels

        Subscription setChannels​(java.util.List<java.lang.String> channels)

      • getUserSubscriptionByNotificationType

        @Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/subscriptions/{notificationType}")
Subscription getUserSubscriptionByNotificationType​(java.lang.String userId,
                                                   java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/subscribe")
void subscribeRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                 java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe")
void subscribeUserSubscriptionByNotificationType​(java.lang.String userId,
                                                 java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions")
SubscriptionList listRoleSubscriptions​(java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                   java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/roles/{roleTypeOrRoleId}/subscriptions/{notificationType}")
Subscription getRoleSubscriptionByNotificationType​(java.lang.String roleTypeOrRoleId,
                                                   java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="POST - /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe")
void unsubscribeUserSubscriptionByNotificationType​(java.lang.String userId,
                                                   java.lang.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="2022-02-14T12:54:39.514-06:00",
           comments="GET - /api/v1/users/{userId}/subscriptions")
SubscriptionList listUserSubscriptions​(java.lang.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