RoleMetadata

pydantic model openapi_client.models.role_metadata.RoleMetadata

Full detail of a single role, returned by GET /roles/{id}. No property is marked required: when projectionExpression is supplied the response is reduced to exactly the requested attributes, and the backend applies no floor to that reduction, so even RoleId can be absent. Without projectionExpression, every property below except RoleDescription and SidenavConfig is present.

Fields:

• created_by (str | None)

• creation_time (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• role_consolidated_permissions (List[str] | None)

• role_description (str | None)

• role_id (str | None)

• role_managers (List[str] | None)

• role_name (str | None)

• role_permissions (List[str] | None)

• role_version (str | None)

• sidenav_config (List[Dict[str, Any]] | None)

• users_attached (List[str] | None)

field role_id: Optional[StrictStr] = None (alias 'RoleId')

Unique identifier of the role, in the form “role-<uuid>”.

field role_name: Optional[StrictStr] = None (alias 'RoleName')

Name of the role. Unique across the platform.

field role_description: Optional[StrictStr] = None (alias 'RoleDescription')

Free-text description of the role. May be empty.

field role_permissions: Optional[List[StrictStr]] = None (alias 'RolePermissions')

Permissions granted directly to this role, each in the form “<service>.<action>”. Returned as an empty array when the role has none.

field role_consolidated_permissions: Optional[List[StrictStr]] = None (alias 'RoleConsolidatedPermissions')

Effective permissions after expanding the transitive dependencies of RolePermissions. Always computed and returned; it is a superset of RolePermissions and cannot be requested or suppressed.

field users_attached: Optional[List[StrictStr]] = None (alias 'UsersAttached')

User IDs attached to the role. Role managers are always included.

field role_managers: Optional[List[StrictStr]] = None (alias 'RoleManagers')

User IDs permitted to update or delete this role. Only these users (or a Super Admin) may call PUT or DELETE on it.

field sidenav_config: Optional[List[Dict[str, Any]]] = None (alias 'SidenavConfig')

Opaque UI navigation configuration stored with the role. The backend persists it without inspecting its structure. Present on non-system roles only.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

Timestamp at which the role was created.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User who created the role.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

Timestamp of the most recent update to the role.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User who last updated the role.

field role_version: Optional[StrictStr] = None (alias 'RoleVersion')

Internal schema version of the role record.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of RoleMetadata from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of RoleMetadata from a dict

Return type:

Optional[Self]