OrganizationRole class

A custom (fine-grained) role defined on a Pulumi Cloud organization. Custom roles allow precise permission control beyond the built-in admin / member / billing-manager roles. Assign them to members via the OrganizationMember.roleId field or to teams via TeamRoleAssignment.

Requires the Custom Roles feature to be enabled on the organization. See the Pulumi Cloud RBAC docs for the shape of the permissions descriptor.

Constructors

OrganizationRole(String name, {OrganizationRoleArgs? args, CustomResourceOptions? options})

Creates a new OrganizationRole. name The Pulumi resource name. args Arguments used to configure this OrganizationRole. The set of arguments for OrganizationRole. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

description ↔ Output<String?>

Human-readable description of what the role grants.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The role's display name. Must be unique within the organization.

late, final

organizationName ↔ Output<String>

The Pulumi Cloud organization name.

late, final

permissions ↔ Output<Map<String, dynamic>>

The role's permission descriptor tree, expressed in the Pulumi Cloud wire grammar. The provider exposes the descriptor as map[string]Any and passes it through verbatim — the wire-format __type discriminator is used at every level (SDK and API alike).

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

resourceType ↔ Output<String?>

The resource type the role's permissions apply to. Defaults to global (the org-wide role that can be assigned to members and teams). Other valid values: stack, environment, insights-account.

late, final

roleId ↔ Output<String>

The unique identifier of the custom role.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

version ↔ Output<int>

The service-maintained version number that increments on every update.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited