> 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/custompermissiongroup.md).

# CustomPermissionGroup

Represents a group of custom permissions for a Security Token

## Hierarchy

↳ [PermissionGroup](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md)

↳ **CustomPermissionGroup**

## Index

### Properties

* [context](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#protected-context)
* [id](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#id)
* [ticker](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#ticker)
* [uuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#uuid)

### Methods

* [getPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#getpermissions)
* [isEqual](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#isequal)
* [setPermissions](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#setpermissions)
* [toJson](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#tojson)
* [generateUuid](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#static-generateuuid)
* [unserialize](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/custompermissiongroup.md#static-unserialize)

## Properties

### `Protected` context

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](https://developers.polymath.network/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)

### id

• **id**: *BigNumber*

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

### ticker

• **ticker**: *string*

*Inherited from* [*PermissionGroup*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/permissiongroup.md)*.*[*ticker*](https://developers.polymath.network/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)

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](https://developers.polymath.network/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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/globals.md#grouppermissions)*›*

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

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

Retrieve the list of permissions and transaction groups associated with this Permission Group

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

### isEqual

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](https://developers.polymath.network/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](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### setPermissions

▸ **setPermissions**(`args`: [SetGroupPermissionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/setgrouppermissionsparams.md), `opts?`: [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

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

Modify the group's permissions

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), which means you can call `setPermissions.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name    | Type                                                                                                                                        |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`  | [SetGroupPermissionsParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/setgrouppermissionsparams.md) |
| `opts?` | [ProcedureOpts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)                         |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹void››*

### toJson

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

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

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

Return the Group's ID

**Returns:** *HumanReadable*

### `Static` generateUuid

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](https://developers.polymath.network/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*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*unserialize*](https://developers.polymath.network/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*
