1. Packages
  2. Okta Provider
  3. API Docs
  4. getAdminRoleCustom
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
okta logo
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi

    Use this data source to retrieve a custom admin role from Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getAdminRoleCustom({
        id: "<role_id>",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_admin_role_custom(id="<role_id>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.LookupAdminRoleCustom(ctx, &okta.LookupAdminRoleCustomArgs{
    			Id: "<role_id>",
    		}, 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.GetAdminRoleCustom.Invoke(new()
        {
            Id = "<role_id>",
        });
    
    });
    
    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.GetAdminRoleCustomArgs;
    import java.util.List;
    import java.util.ArrayList;
    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.getAdminRoleCustom(GetAdminRoleCustomArgs.builder()
                .id("<role_id>")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: okta:getAdminRoleCustom
          arguments:
            id: <role_id>
    

    Using getAdminRoleCustom

    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 getAdminRoleCustom(args: GetAdminRoleCustomArgs, opts?: InvokeOptions): Promise<GetAdminRoleCustomResult>
    function getAdminRoleCustomOutput(args: GetAdminRoleCustomOutputArgs, opts?: InvokeOptions): Output<GetAdminRoleCustomResult>
    def get_admin_role_custom(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAdminRoleCustomResult
    def get_admin_role_custom_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAdminRoleCustomResult]
    func LookupAdminRoleCustom(ctx *Context, args *LookupAdminRoleCustomArgs, opts ...InvokeOption) (*LookupAdminRoleCustomResult, error)
    func LookupAdminRoleCustomOutput(ctx *Context, args *LookupAdminRoleCustomOutputArgs, opts ...InvokeOption) LookupAdminRoleCustomResultOutput

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

    public static class GetAdminRoleCustom 
    {
        public static Task<GetAdminRoleCustomResult> InvokeAsync(GetAdminRoleCustomArgs args, InvokeOptions? opts = null)
        public static Output<GetAdminRoleCustomResult> Invoke(GetAdminRoleCustomInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAdminRoleCustomResult> getAdminRoleCustom(GetAdminRoleCustomArgs args, InvokeOptions options)
    public static Output<GetAdminRoleCustomResult> getAdminRoleCustom(GetAdminRoleCustomArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getAdminRoleCustom:getAdminRoleCustom
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier for the custom role. Accepts the role ID or label.
    Id string
    The unique identifier for the custom role. Accepts the role ID or label.
    id String
    The unique identifier for the custom role. Accepts the role ID or label.
    id string
    The unique identifier for the custom role. Accepts the role ID or label.
    id str
    The unique identifier for the custom role. Accepts the role ID or label.
    id String
    The unique identifier for the custom role. Accepts the role ID or label.

    getAdminRoleCustom Result

    The following output properties are available:

    Description string
    A human-readable description of the custom role.
    Id string
    The unique identifier for the custom role. Accepts the role ID or label.
    Label string
    The name given to the custom role.
    Permissions List<string>
    The permissions that the custom role grants.
    Description string
    A human-readable description of the custom role.
    Id string
    The unique identifier for the custom role. Accepts the role ID or label.
    Label string
    The name given to the custom role.
    Permissions []string
    The permissions that the custom role grants.
    description String
    A human-readable description of the custom role.
    id String
    The unique identifier for the custom role. Accepts the role ID or label.
    label String
    The name given to the custom role.
    permissions List<String>
    The permissions that the custom role grants.
    description string
    A human-readable description of the custom role.
    id string
    The unique identifier for the custom role. Accepts the role ID or label.
    label string
    The name given to the custom role.
    permissions string[]
    The permissions that the custom role grants.
    description str
    A human-readable description of the custom role.
    id str
    The unique identifier for the custom role. Accepts the role ID or label.
    label str
    The name given to the custom role.
    permissions Sequence[str]
    The permissions that the custom role grants.
    description String
    A human-readable description of the custom role.
    id String
    The unique identifier for the custom role. Accepts the role ID or label.
    label String
    The name given to the custom role.
    permissions List<String>
    The permissions that the custom role grants.

    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 v6.3.1
    published on Thursday, Mar 12, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.