1. Packages
  2. Github Provider
  3. API Docs
  4. getOrganizationRepositoryRole
GitHub v6.8.0 published on Thursday, Oct 23, 2025 by Pulumi

github.getOrganizationRepositoryRole

Get Started
github logo
GitHub v6.8.0 published on Thursday, Oct 23, 2025 by Pulumi

    Lookup a custom organization repository role.

    Note: Custom organization repository roles are currently only available in GitHub Enterprise Cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as github from "@pulumi/github";
    
    const example = github.getOrganizationRepositoryRole({
        roleId: 1234,
    });
    
    import pulumi
    import pulumi_github as github
    
    example = github.get_organization_repository_role(role_id=1234)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := github.LookupOrganizationRepositoryRole(ctx, &github.LookupOrganizationRepositoryRoleArgs{
    			RoleId: 1234,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Github = Pulumi.Github;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Github.GetOrganizationRepositoryRole.Invoke(new()
        {
            RoleId = 1234,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.github.GithubFunctions;
    import com.pulumi.github.inputs.GetOrganizationRepositoryRoleArgs;
    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 = GithubFunctions.getOrganizationRepositoryRole(GetOrganizationRepositoryRoleArgs.builder()
                .roleId(1234)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: github:getOrganizationRepositoryRole
          arguments:
            roleId: 1234
    

    Using getOrganizationRepositoryRole

    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 getOrganizationRepositoryRole(args: GetOrganizationRepositoryRoleArgs, opts?: InvokeOptions): Promise<GetOrganizationRepositoryRoleResult>
    function getOrganizationRepositoryRoleOutput(args: GetOrganizationRepositoryRoleOutputArgs, opts?: InvokeOptions): Output<GetOrganizationRepositoryRoleResult>
    def get_organization_repository_role(role_id: Optional[int] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetOrganizationRepositoryRoleResult
    def get_organization_repository_role_output(role_id: Optional[pulumi.Input[int]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationRepositoryRoleResult]
    func LookupOrganizationRepositoryRole(ctx *Context, args *LookupOrganizationRepositoryRoleArgs, opts ...InvokeOption) (*LookupOrganizationRepositoryRoleResult, error)
    func LookupOrganizationRepositoryRoleOutput(ctx *Context, args *LookupOrganizationRepositoryRoleOutputArgs, opts ...InvokeOption) LookupOrganizationRepositoryRoleResultOutput

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

    public static class GetOrganizationRepositoryRole 
    {
        public static Task<GetOrganizationRepositoryRoleResult> InvokeAsync(GetOrganizationRepositoryRoleArgs args, InvokeOptions? opts = null)
        public static Output<GetOrganizationRepositoryRoleResult> Invoke(GetOrganizationRepositoryRoleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationRepositoryRoleResult> getOrganizationRepositoryRole(GetOrganizationRepositoryRoleArgs args, InvokeOptions options)
    public static Output<GetOrganizationRepositoryRoleResult> getOrganizationRepositoryRole(GetOrganizationRepositoryRoleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: github:index/getOrganizationRepositoryRole:getOrganizationRepositoryRole
      arguments:
        # arguments dictionary

    The following arguments are supported:

    RoleId int
    The ID of the organization repository role.
    RoleId int
    The ID of the organization repository role.
    roleId Integer
    The ID of the organization repository role.
    roleId number
    The ID of the organization repository role.
    role_id int
    The ID of the organization repository role.
    roleId Number
    The ID of the organization repository role.

    getOrganizationRepositoryRole Result

    The following output properties are available:

    BaseRole string
    The system role from which this role inherits permissions.
    Description string
    The description of the organization repository role.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the organization repository role.
    Permissions List<string>
    The permissions included in this role.
    RoleId int
    The ID of the organization repository role.
    BaseRole string
    The system role from which this role inherits permissions.
    Description string
    The description of the organization repository role.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the organization repository role.
    Permissions []string
    The permissions included in this role.
    RoleId int
    The ID of the organization repository role.
    baseRole String
    The system role from which this role inherits permissions.
    description String
    The description of the organization repository role.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the organization repository role.
    permissions List<String>
    The permissions included in this role.
    roleId Integer
    The ID of the organization repository role.
    baseRole string
    The system role from which this role inherits permissions.
    description string
    The description of the organization repository role.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the organization repository role.
    permissions string[]
    The permissions included in this role.
    roleId number
    The ID of the organization repository role.
    base_role str
    The system role from which this role inherits permissions.
    description str
    The description of the organization repository role.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the organization repository role.
    permissions Sequence[str]
    The permissions included in this role.
    role_id int
    The ID of the organization repository role.
    baseRole String
    The system role from which this role inherits permissions.
    description String
    The description of the organization repository role.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the organization repository role.
    permissions List<String>
    The permissions included in this role.
    roleId Number
    The ID of the organization repository role.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.8.0 published on Thursday, Oct 23, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate