Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. projects
  5. getIamCustomRoles
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.projects.getIamCustomRoles

Explore with Pulumi AI

gcp logo
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

    Get information about Google Cloud IAM Custom Roles from a project. Note that you must have the roles/iam.roleViewer. See the official documentation and API.

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = gcp.projects.getIamCustomRoles({
    project: "your-project-id",
    showDeleted: true,
    view: "FULL",
});

    import pulumi
import pulumi_gcp as gcp

example = gcp.projects.get_iam_custom_roles(project="your-project-id",
    show_deleted=True,
    view="FULL")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projects.GetIamCustomRoles(ctx, &projects.GetIamCustomRolesArgs{
			Project:     pulumi.StringRef("your-project-id"),
			ShowDeleted: pulumi.BoolRef(true),
			View:        pulumi.StringRef("FULL"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = Gcp.Projects.GetIamCustomRoles.Invoke(new()
    {
        Project = "your-project-id",
        ShowDeleted = true,
        View = "FULL",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.ProjectsFunctions;
import com.pulumi.gcp.projects.inputs.GetIamCustomRolesArgs;
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 = ProjectsFunctions.getIamCustomRoles(GetIamCustomRolesArgs.builder()
            .project("your-project-id")
            .showDeleted(true)
            .view("FULL")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: gcp:projects:getIamCustomRoles
      arguments:
        project: your-project-id
        showDeleted: true
        view: FULL

    Using getIamCustomRoles

    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 getIamCustomRoles(args: GetIamCustomRolesArgs, opts?: InvokeOptions): Promise<GetIamCustomRolesResult>
function getIamCustomRolesOutput(args: GetIamCustomRolesOutputArgs, opts?: InvokeOptions): Output<GetIamCustomRolesResult>
    def get_iam_custom_roles(project: Optional[str] = None,
                         show_deleted: Optional[bool] = None,
                         view: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIamCustomRolesResult
def get_iam_custom_roles_output(project: Optional[pulumi.Input[str]] = None,
                         show_deleted: Optional[pulumi.Input[bool]] = None,
                         view: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIamCustomRolesResult]
    func GetIamCustomRoles(ctx *Context, args *GetIamCustomRolesArgs, opts ...InvokeOption) (*GetIamCustomRolesResult, error)
func GetIamCustomRolesOutput(ctx *Context, args *GetIamCustomRolesOutputArgs, opts ...InvokeOption) GetIamCustomRolesResultOutput

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

    public static class GetIamCustomRoles 
{
    public static Task<GetIamCustomRolesResult> InvokeAsync(GetIamCustomRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetIamCustomRolesResult> Invoke(GetIamCustomRolesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIamCustomRolesResult> getIamCustomRoles(GetIamCustomRolesArgs args, InvokeOptions options)
public static Output<GetIamCustomRolesResult> getIamCustomRoles(GetIamCustomRolesArgs args, InvokeOptions options)

    fn::invoke:
  function: gcp:projects/getIamCustomRoles:getIamCustomRoles
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Project string
    The project were the custom role has been created in. Defaults to the provider project configuration.
    ShowDeleted bool
    Include Roles that have been deleted. Defaults to false.
    View string
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.
    Project string
    The project were the custom role has been created in. Defaults to the provider project configuration.
    ShowDeleted bool
    Include Roles that have been deleted. Defaults to false.
    View string
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.
    project String
    The project were the custom role has been created in. Defaults to the provider project configuration.
    showDeleted Boolean
    Include Roles that have been deleted. Defaults to false.
    view String
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.
    project string
    The project were the custom role has been created in. Defaults to the provider project configuration.
    showDeleted boolean
    Include Roles that have been deleted. Defaults to false.
    view string
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.
    project str
    The project were the custom role has been created in. Defaults to the provider project configuration.
    show_deleted bool
    Include Roles that have been deleted. Defaults to false.
    view str
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.
    project String
    The project were the custom role has been created in. Defaults to the provider project configuration.
    showDeleted Boolean
    Include Roles that have been deleted. Defaults to false.
    view String
    When "FULL" is specified, the permissions field is returned, which includes a list of all permissions in the role. The default value is "BASIC", which does not return the permissions.

    getIamCustomRoles Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Roles List<GetIamCustomRolesRole>
    A list of all retrieved custom roles roles. Structure is defined below.
    Project string
    ShowDeleted bool
    View string
    Id string
    The provider-assigned unique ID for this managed resource.
    Roles []GetIamCustomRolesRole
    A list of all retrieved custom roles roles. Structure is defined below.
    Project string
    ShowDeleted bool
    View string
    id String
    The provider-assigned unique ID for this managed resource.
    roles List<GetIamCustomRolesRole>
    A list of all retrieved custom roles roles. Structure is defined below.
    project String
    showDeleted Boolean
    view String
    id string
    The provider-assigned unique ID for this managed resource.
    roles GetIamCustomRolesRole[]
    A list of all retrieved custom roles roles. Structure is defined below.
    project string
    showDeleted boolean
    view string
    id str
    The provider-assigned unique ID for this managed resource.
    roles Sequence[GetIamCustomRolesRole]
    A list of all retrieved custom roles roles. Structure is defined below.
    project str
    show_deleted bool
    view str
    id String
    The provider-assigned unique ID for this managed resource.
    roles List<Property Map>
    A list of all retrieved custom roles roles. Structure is defined below.
    project String
    showDeleted Boolean
    view String

    Supporting Types

    GetIamCustomRolesRole

    Deleted bool
    The current deleted state of the role.
    Description string
    A human-readable description for the role.
    Id string
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    Name string
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    Permissions List<string>
    The names of the permissions this role grants when bound in an IAM policy.
    RoleId string
    The camel case role id used for this role.
    Stage string
    The current launch stage of the role. List of possible stages is here.
    Title string
    A human-readable title for the role.
    Deleted bool
    The current deleted state of the role.
    Description string
    A human-readable description for the role.
    Id string
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    Name string
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    Permissions []string
    The names of the permissions this role grants when bound in an IAM policy.
    RoleId string
    The camel case role id used for this role.
    Stage string
    The current launch stage of the role. List of possible stages is here.
    Title string
    A human-readable title for the role.
    deleted Boolean
    The current deleted state of the role.
    description String
    A human-readable description for the role.
    id String
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    name String
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    permissions List<String>
    The names of the permissions this role grants when bound in an IAM policy.
    roleId String
    The camel case role id used for this role.
    stage String
    The current launch stage of the role. List of possible stages is here.
    title String
    A human-readable title for the role.
    deleted boolean
    The current deleted state of the role.
    description string
    A human-readable description for the role.
    id string
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    name string
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    permissions string[]
    The names of the permissions this role grants when bound in an IAM policy.
    roleId string
    The camel case role id used for this role.
    stage string
    The current launch stage of the role. List of possible stages is here.
    title string
    A human-readable title for the role.
    deleted bool
    The current deleted state of the role.
    description str
    A human-readable description for the role.
    id str
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    name str
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    permissions Sequence[str]
    The names of the permissions this role grants when bound in an IAM policy.
    role_id str
    The camel case role id used for this role.
    stage str
    The current launch stage of the role. List of possible stages is here.
    title str
    A human-readable title for the role.
    deleted Boolean
    The current deleted state of the role.
    description String
    A human-readable description for the role.
    id String
    an identifier for the resource with the format projects/{{project}}/roles/{{role_id}}.
    name String
    The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
    permissions List<String>
    The names of the permissions this role grants when bound in an IAM policy.
    roleId String
    The camel case role id used for this role.
    stage String
    The current launch stage of the role. List of possible stages is here.
    title String
    A human-readable title for the role.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp