Google Cloud Native v0.28.0, Feb 2 23

google-native.iam/v1.getOrganizationRole

Gets the definition of a Role.

Using getOrganizationRole

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 getOrganizationRole(args: GetOrganizationRoleArgs, opts?: InvokeOptions): Promise<GetOrganizationRoleResult>
function getOrganizationRoleOutput(args: GetOrganizationRoleOutputArgs, opts?: InvokeOptions): Output<GetOrganizationRoleResult>

def get_organization_role(organization_id: Optional[str] = None,
                          role_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetOrganizationRoleResult
def get_organization_role_output(organization_id: Optional[pulumi.Input[str]] = None,
                          role_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationRoleResult]

func LookupOrganizationRole(ctx *Context, args *LookupOrganizationRoleArgs, opts ...InvokeOption) (*LookupOrganizationRoleResult, error)
func LookupOrganizationRoleOutput(ctx *Context, args *LookupOrganizationRoleOutputArgs, opts ...InvokeOption) LookupOrganizationRoleResultOutput

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

public static class GetOrganizationRole 
{
    public static Task<GetOrganizationRoleResult> InvokeAsync(GetOrganizationRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationRoleResult> Invoke(GetOrganizationRoleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationRoleResult> getOrganizationRole(GetOrganizationRoleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:iam/v1:getOrganizationRole
  arguments:
    # arguments dictionary

The following arguments are supported:

OrganizationId string
RoleId string

OrganizationId string
RoleId string

organizationId String
roleId String

organizationId string
roleId string

organization_id str
role_id str

organizationId String
roleId String

getOrganizationRole Result

The following output properties are available:

Deleted bool: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
Description string: Optional. A human-readable description for the role.
Etag string: Used to perform a consistent read-modify-write.
IncludedPermissions List<string>: The names of the permissions this role grants when bound in an IAM policy.
Name string: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Stage string: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
Title string: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Deleted bool: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
Description string: Optional. A human-readable description for the role.
Etag string: Used to perform a consistent read-modify-write.
IncludedPermissions []string: The names of the permissions this role grants when bound in an IAM policy.
Name string: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Stage string: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
Title string: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

deleted Boolean: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
description String: Optional. A human-readable description for the role.
etag String: Used to perform a consistent read-modify-write.
includedPermissions List<String>: The names of the permissions this role grants when bound in an IAM policy.
name String: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
stage String: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
title String: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

deleted boolean: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
description string: Optional. A human-readable description for the role.
etag string: Used to perform a consistent read-modify-write.
includedPermissions string[]: The names of the permissions this role grants when bound in an IAM policy.
name string: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
stage string: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
title string: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

deleted bool: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
description str: Optional. A human-readable description for the role.
etag str: Used to perform a consistent read-modify-write.
included_permissions Sequence[str]: The names of the permissions this role grants when bound in an IAM policy.
name str: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
stage str: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
title str: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

deleted Boolean: The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.
description String: Optional. A human-readable description for the role.
etag String: Used to perform a consistent read-modify-write.
includedPermissions List<String>: The names of the permissions this role grants when bound in an IAM policy.
name String: The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
stage String: The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role.
title String: Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

google-native.iam/v1.getOrganizationRole

Using getOrganizationRole

getOrganizationRole Result

Package Details

Contents