Okta.Sdk.Api.SubscriptionApi

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
GetSubscriptionsNotificationTypeRole	GET /api/v1/roles/{roleRef}/subscriptions/{notificationType}	Retrieve a Subscription for a Role
GetSubscriptionsNotificationTypeUser	GET /api/v1/users/{userId}/subscriptions/{notificationType}	Retrieve a Subscription for a User
ListSubscriptionsRole	GET /api/v1/roles/{roleRef}/subscriptions	List all Subscriptions for a Role
ListSubscriptionsUser	GET /api/v1/users/{userId}/subscriptions	List all Subscriptions for a User
SubscribeByNotificationTypeRole	POST /api/v1/roles/{roleRef}/subscriptions/{notificationType}/subscribe	Subscribe a Role to a Specific Notification Type
SubscribeByNotificationTypeUser	POST /api/v1/users/{userId}/subscriptions/{notificationType}/subscribe	Subscribe a User to a Specific Notification Type
UnsubscribeByNotificationTypeRole	POST /api/v1/roles/{roleRef}/subscriptions/{notificationType}/unsubscribe	Unsubscribe a Role from a Specific Notification Type
UnsubscribeByNotificationTypeUser	POST /api/v1/users/{userId}/subscriptions/{notificationType}/unsubscribe	Unsubscribe a User from a Specific Notification Type

GetSubscriptionsNotificationTypeRole

Subscription GetSubscriptionsNotificationTypeRole (ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)

Retrieve a Subscription for a Role

Retrieves a subscription by notificationType for a specified Role

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetSubscriptionsNotificationTypeRoleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var roleRef = new ListSubscriptionsRoleRoleRefParameter(); // ListSubscriptionsRoleRoleRefParameter | A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Roles](/openapi/okta-management/guides/roles/#standard-roles).
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 

            try
            {
                // Retrieve a Subscription for a Role
                Subscription result = apiInstance.GetSubscriptionsNotificationTypeRole(roleRef, notificationType);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.GetSubscriptionsNotificationTypeRole: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Roles.
notificationType	NotificationType

Return type

Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubscriptionsNotificationTypeUser

Subscription GetSubscriptionsNotificationTypeUser (NotificationType notificationType, string userId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class GetSubscriptionsNotificationTypeUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // Retrieve a Subscription for a User
                Subscription result = apiInstance.GetSubscriptionsNotificationTypeUser(notificationType, userId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.GetSubscriptionsNotificationTypeUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
notificationType	NotificationType
userId	string	ID of an existing Okta user

Return type

Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSubscriptionsRole

List<Subscription> ListSubscriptionsRole (ListSubscriptionsRoleRoleRefParameter roleRef)

List all Subscriptions for a Role

Lists all subscriptions available to a specified Role

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListSubscriptionsRoleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var roleRef = new ListSubscriptionsRoleRoleRefParameter(); // ListSubscriptionsRoleRoleRefParameter | A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Roles](/openapi/okta-management/guides/roles/#standard-roles).

            try
            {
                // List all Subscriptions for a Role
                List<Subscription> result = apiInstance.ListSubscriptionsRole(roleRef).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.ListSubscriptionsRole: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Roles.

Return type

List<Subscription>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSubscriptionsUser

List<Subscription> ListSubscriptionsUser (string userId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class ListSubscriptionsUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // List all Subscriptions for a User
                List<Subscription> result = apiInstance.ListSubscriptionsUser(userId).ToListAsync();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.ListSubscriptionsUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
userId	string	ID of an existing Okta user

Return type

List<Subscription>

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SubscribeByNotificationTypeRole

void SubscribeByNotificationTypeRole (ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class SubscribeByNotificationTypeRoleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var roleRef = new ListSubscriptionsRoleRoleRefParameter(); // ListSubscriptionsRoleRoleRefParameter | A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Roles](/openapi/okta-management/guides/roles/#standard-roles).
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 

            try
            {
                // Subscribe a Role to a Specific Notification Type
                apiInstance.SubscribeByNotificationTypeRole(roleRef, notificationType);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.SubscribeByNotificationTypeRole: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Roles.
notificationType	NotificationType

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SubscribeByNotificationTypeUser

void SubscribeByNotificationTypeUser (NotificationType notificationType, string userId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class SubscribeByNotificationTypeUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // Subscribe a User to a Specific Notification Type
                apiInstance.SubscribeByNotificationTypeUser(notificationType, userId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.SubscribeByNotificationTypeUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
notificationType	NotificationType
userId	string	ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnsubscribeByNotificationTypeRole

void UnsubscribeByNotificationTypeRole (ListSubscriptionsRoleRoleRefParameter roleRef, NotificationType notificationType)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class UnsubscribeByNotificationTypeRoleExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var roleRef = new ListSubscriptionsRoleRoleRefParameter(); // ListSubscriptionsRoleRoleRefParameter | A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See [Standard Roles](/openapi/okta-management/guides/roles/#standard-roles).
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 

            try
            {
                // Unsubscribe a Role from a Specific Notification Type
                apiInstance.UnsubscribeByNotificationTypeRole(roleRef, notificationType);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.UnsubscribeByNotificationTypeRole: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Roles.
notificationType	NotificationType

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnsubscribeByNotificationTypeUser

void UnsubscribeByNotificationTypeUser (NotificationType notificationType, string userId)

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.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Okta.Sdk.Api;
using Okta.Sdk.Client;
using Okta.Sdk.Model;

namespace Example
{
    public class UnsubscribeByNotificationTypeUserExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.OktaDomain = "https://subdomain.okta.com";
            // Configure API key authorization: apiToken
            config.Token ="YOUR_API_KEY";
            // Configure OAuth2 access token for authorization: oauth2
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new SubscriptionApi(config);
            var notificationType = (NotificationType) "AD_AGENT";  // NotificationType | 
            var userId = "userId_example";  // string | ID of an existing Okta user

            try
            {
                // Unsubscribe a User from a Specific Notification Type
                apiInstance.UnsubscribeByNotificationTypeUser(notificationType, userId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SubscriptionApi.UnsubscribeByNotificationTypeUser: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
notificationType	NotificationType
userId	string	ID of an existing Okta user

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SubscriptionApi.md

Latest commit

History

SubscriptionApi.md

File metadata and controls

Okta.Sdk.Api.SubscriptionApi

GetSubscriptionsNotificationTypeRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetSubscriptionsNotificationTypeUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListSubscriptionsRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListSubscriptionsUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SubscribeByNotificationTypeRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

SubscribeByNotificationTypeUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UnsubscribeByNotificationTypeRole

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

UnsubscribeByNotificationTypeUser

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details