Organizations

UpdateRole

Updates an existing custom role's name, description, or permission scopes. Changes take effect immediately for all members and teams assigned to the role. The same limits that apply to CreateRole apply here: a permission descriptor group may contain at most 2000 entries, and the total serialized size of the role definition may not exceed 1 MB. Exceeding either limit returns a 400 error.

patch/api/orgs/{orgName}/roles/{roleID}

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/orgs/{orgName}/roles/{roleID}
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

roleIDstring required

The role identifier

Request body

descriptionstring

The new description for the role.

namestring

The new name for the role.

Response

OK

descriptionstring

A human-readable description of the permission descriptor.

namestring

The name of the permission descriptor.

resourceTypestring

The resource type this permission descriptor applies to.

uxPurpose'role' | 'role_private' | 'role_temporary' | 'policy' | 'set'

The UX purpose of this permission descriptor (e.g. role, policy, set).

createdstring date-time required

When the role was created.

defaultIdentifierstring

The identifier for default roles. Empty for custom roles.

idstring required

The unique identifier for this role.

isOrgDefaultboolean required

Whether this role is the organization default.

modifiedstring date-time required

When the role was last modified.

orgIdstring required

The ID of the organization this role belongs to.

versioninteger required

The version of this role.

Changes

No recorded changes to this operation across all 1 revision of this API.