1. Registry
  2. Packages
  3. Okta Provider
  4. API Docs
  5. getRoleSubscription
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi
okta logo
Viewing docs for Okta v7.0.0
published on Friday, Sep 11, 2026 by Pulumi

    Retrieves a subscription by notification type for a specified role.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getRoleSubscription({
        roleRef: "SUPER_ADMIN",
        id: "APP_IMPORT",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_role_subscription(role_ref="SUPER_ADMIN",
        id="APP_IMPORT")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v7/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.GetRoleSubscription(ctx, &okta.LookupRoleSubscriptionArgs{
    			RoleRef: "SUPER_ADMIN",
    			Id:      "APP_IMPORT",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.GetRoleSubscription.Invoke(new()
        {
            RoleRef = "SUPER_ADMIN",
            Id = "APP_IMPORT",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetRoleSubscriptionArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = OktaFunctions.getRoleSubscription(GetRoleSubscriptionArgs.builder()
                .roleRef("SUPER_ADMIN")
                .id("APP_IMPORT")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: okta:getRoleSubscription
          arguments:
            roleRef: SUPER_ADMIN
            id: APP_IMPORT
    
    pulumi {
      required_providers {
        okta = {
          source = "pulumi/okta"
        }
      }
    }
    
    data "okta_getrolesubscription" "example" {
      role_ref = "SUPER_ADMIN"
      id       = "APP_IMPORT"
    }
    

    Using getRoleSubscription

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRoleSubscription(args: GetRoleSubscriptionArgs, opts?: InvokeOptions): Promise<GetRoleSubscriptionResult>
    function getRoleSubscriptionOutput(args: GetRoleSubscriptionOutputArgs, opts?: InvokeOutputOptions): Output<GetRoleSubscriptionResult>
    def get_role_subscription(id: Optional[str] = None,
                              role_ref: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRoleSubscriptionResult
    def get_role_subscription_output(id: pulumi.Input[Optional[str]] = None,
                              role_ref: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetRoleSubscriptionResult]
    func LookupRoleSubscription(ctx *Context, args *LookupRoleSubscriptionArgs, opts ...InvokeOption) (*LookupRoleSubscriptionResult, error)
    func LookupRoleSubscriptionOutput(ctx *Context, args *LookupRoleSubscriptionOutputArgs, opts ...InvokeOption) LookupRoleSubscriptionResultOutput

    > Note: This function is named LookupRoleSubscription in the Go SDK.

    public static class GetRoleSubscription 
    {
        public static Task<GetRoleSubscriptionResult> InvokeAsync(GetRoleSubscriptionArgs args, InvokeOptions? opts = null)
        public static Output<GetRoleSubscriptionResult> Invoke(GetRoleSubscriptionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetRoleSubscriptionResult> Invoke(GetRoleSubscriptionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetRoleSubscriptionResult> getRoleSubscription(GetRoleSubscriptionArgs args, InvokeOptions options)
    public static Output<GetRoleSubscriptionResult> getRoleSubscription(GetRoleSubscriptionArgs args, InvokeOptions options)
    public static Output<GetRoleSubscriptionResult> getRoleSubscription(GetRoleSubscriptionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: okta:index/getRoleSubscription:getRoleSubscription
      arguments:
        # arguments dictionary
    data "okta_get_role_subscription" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    RoleRef string
    Id string
    RoleRef string
    id string
    role_ref string
    id String
    roleRef String
    id string
    roleRef string
    id str
    role_ref str
    id String
    roleRef String

    getRoleSubscription Result

    The following output properties are available:

    Channels List<string>
    Id string
    NotificationType string
    RoleRef string
    Status string
    Channels []string
    Id string
    NotificationType string
    RoleRef string
    Status string
    channels list(string)
    id string
    notification_type string
    role_ref string
    status string
    channels List<String>
    id String
    notificationType String
    roleRef String
    status String
    channels string[]
    id string
    notificationType string
    roleRef string
    status string
    channels Sequence[str]
    id str
    notification_type str
    role_ref str
    status str
    channels List<String>
    id String
    notificationType String
    roleRef String
    status String

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v7.0.0
    published on Friday, Sep 11, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial