\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(ctx, roleRef, notificationType).Execute()

Retrieve a Subscription for a Role

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    roleRef := openapiclient.listSubscriptionsRole_roleRef_parameter{String: new(string)} // ListSubscriptionsRoleRoleRefParameter | 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).
    notificationType := "notificationType_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionAPI.GetSubscriptionsNotificationTypeRole(context.Background(), roleRef, notificationType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.GetSubscriptionsNotificationTypeRole``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSubscriptionsNotificationTypeRole`: Subscription
    fmt.Fprintf(os.Stdout, "Response from `SubscriptionAPI.GetSubscriptionsNotificationTypeRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Role Types.
notificationType	string

Other Parameters

Other parameters are passed through a pointer to a apiGetSubscriptionsNotificationTypeRoleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSubscriptionsNotificationTypeUser

Subscription GetSubscriptionsNotificationTypeUser(ctx, notificationType, userId).Execute()

Retrieve a Subscription for a User

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    notificationType := "notificationType_example" // string | 
    userId := "userId_example" // string | ID of an existing Okta user

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionAPI.GetSubscriptionsNotificationTypeUser(context.Background(), notificationType, userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.GetSubscriptionsNotificationTypeUser``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetSubscriptionsNotificationTypeUser`: Subscription
    fmt.Fprintf(os.Stdout, "Response from `SubscriptionAPI.GetSubscriptionsNotificationTypeUser`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
notificationType	string
userId	string	ID of an existing Okta user

Other Parameters

Other parameters are passed through a pointer to a apiGetSubscriptionsNotificationTypeUserRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListSubscriptionsRole

[]Subscription ListSubscriptionsRole(ctx, roleRef).Execute()

List all Subscriptions for a Role

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    roleRef := openapiclient.listSubscriptionsRole_roleRef_parameter{String: new(string)} // ListSubscriptionsRoleRoleRefParameter | 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).

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionAPI.ListSubscriptionsRole(context.Background(), roleRef).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.ListSubscriptionsRole``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListSubscriptionsRole`: []Subscription
    fmt.Fprintf(os.Stdout, "Response from `SubscriptionAPI.ListSubscriptionsRole`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Role Types.

Other Parameters

Other parameters are passed through a pointer to a apiListSubscriptionsRoleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListSubscriptionsUser

[]Subscription ListSubscriptionsUser(ctx, userId).Execute()

List all Subscriptions for a User

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    userId := "userId_example" // string | ID of an existing Okta user

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.SubscriptionAPI.ListSubscriptionsUser(context.Background(), userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.ListSubscriptionsUser``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListSubscriptionsUser`: []Subscription
    fmt.Fprintf(os.Stdout, "Response from `SubscriptionAPI.ListSubscriptionsUser`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	string	ID of an existing Okta user

Other Parameters

Other parameters are passed through a pointer to a apiListSubscriptionsUserRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]Subscription

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

SubscribeByNotificationTypeRole

SubscribeByNotificationTypeRole(ctx, roleRef, notificationType).Execute()

Subscribe a Role to a Specific Notification Type

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    roleRef := openapiclient.listSubscriptionsRole_roleRef_parameter{String: new(string)} // ListSubscriptionsRoleRoleRefParameter | 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).
    notificationType := "notificationType_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.SubscriptionAPI.SubscribeByNotificationTypeRole(context.Background(), roleRef, notificationType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.SubscribeByNotificationTypeRole``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Role Types.
notificationType	string

Other Parameters

Other parameters are passed through a pointer to a apiSubscribeByNotificationTypeRoleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

SubscribeByNotificationTypeUser

SubscribeByNotificationTypeUser(ctx, notificationType, userId).Execute()

Subscribe a User to a Specific Notification Type

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    notificationType := "notificationType_example" // string | 
    userId := "userId_example" // string | ID of an existing Okta user

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.SubscriptionAPI.SubscribeByNotificationTypeUser(context.Background(), notificationType, userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.SubscribeByNotificationTypeUser``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
notificationType	string
userId	string	ID of an existing Okta user

Other Parameters

Other parameters are passed through a pointer to a apiSubscribeByNotificationTypeUserRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UnsubscribeByNotificationTypeRole

UnsubscribeByNotificationTypeRole(ctx, roleRef, notificationType).Execute()

Unsubscribe a Role from a Specific Notification Type

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    roleRef := openapiclient.listSubscriptionsRole_roleRef_parameter{String: new(string)} // ListSubscriptionsRoleRoleRefParameter | 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).
    notificationType := "notificationType_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.SubscriptionAPI.UnsubscribeByNotificationTypeRole(context.Background(), roleRef, notificationType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.UnsubscribeByNotificationTypeRole``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleRef	ListSubscriptionsRoleRoleRefParameter	A reference to an existing role. Standard roles require a `roleType`, while Custom Roles require a `roleId`. See Standard Role Types.
notificationType	string

Other Parameters

Other parameters are passed through a pointer to a apiUnsubscribeByNotificationTypeRoleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UnsubscribeByNotificationTypeUser

UnsubscribeByNotificationTypeUser(ctx, notificationType, userId).Execute()

Unsubscribe a User from a Specific Notification Type

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lukas-hetzenecker/okta-sdk-golang"
)

func main() {
    notificationType := "notificationType_example" // string | 
    userId := "userId_example" // string | ID of an existing Okta user

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.SubscriptionAPI.UnsubscribeByNotificationTypeUser(context.Background(), notificationType, userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.UnsubscribeByNotificationTypeUser``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
notificationType	string
userId	string	ID of an existing Okta user

Other Parameters

Other parameters are passed through a pointer to a apiUnsubscribeByNotificationTypeUserRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[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

\SubscriptionAPI

GetSubscriptionsNotificationTypeRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSubscriptionsNotificationTypeUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListSubscriptionsRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListSubscriptionsUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SubscribeByNotificationTypeRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SubscribeByNotificationTypeUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UnsubscribeByNotificationTypeRole

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UnsubscribeByNotificationTypeUser

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers