> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md).

# KnownPermissionGroup

Represents a pre-defined group of permissions for a Security Token

## Hierarchy

↳ [PermissionGroup](/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md)

↳ **KnownPermissionGroup**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#protected-context)
* [ticker](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#ticker)
* [type](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#type)
* [uuid](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#uuid)

### Methods

* [getPermissions](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#getpermissions)
* [isEqual](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#isequal)
* [toJson](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#tojson)
* [generateUuid](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v9/classes/knownpermissiongroup.md#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md)

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L48)

### ticker

• **ticker**: *string*

*Inherited from* [*PermissionGroup*](/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md)*.*[*ticker*](/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md#ticker)

*Defined in* [*src/api/entities/PermissionGroup.ts:27*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/PermissionGroup.ts#L27)

### type

• **type**: [*PermissionGroupType*](/polymesh-sdk-api-reference/docs-v9/enums/permissiongrouptype.md)

*Defined in* [*src/api/entities/KnownPermissionGroup.ts:30*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/KnownPermissionGroup.ts#L30)

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L46)

## Methods

### getPermissions

▸ **getPermissions**(): *Promise‹*[*GroupPermissions*](/polymesh-sdk-api-reference/docs-v9/globals.md#grouppermissions)*›*

*Overrides* [*PermissionGroup*](/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md)*.*[*getPermissions*](/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md#abstract-getpermissions)

*Defined in* [*src/api/entities/KnownPermissionGroup.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/KnownPermissionGroup.ts#L46)

Retrieve the Permissions associated with this Permission Group

**Returns:** *Promise‹*[*GroupPermissions*](/polymesh-sdk-api-reference/docs-v9/globals.md#grouppermissions)*›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                              |
| -------- | --------------------------------------------------------------------------------- |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### toJson

▸ **toJson**(): *HumanReadable*

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/KnownPermissionGroup.ts:90*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/KnownPermissionGroup.ts#L90)

Return the KnownPermissionGroup's static data

**Returns:** *HumanReadable*

### `Static` generateUuid

▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L14)

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*
