Interface PermissionRequestModel

Represents the structured data model of a PermissionsRequest record, encapsulating the essential fields that define the request's data and payload within a Decentralized Web Node (DWN).

interface PermissionRequestModel {
    conditions?: PermissionConditions;
    delegated?: boolean;
    description?: string;
    id: string;
    requester: string;
    scope: PermissionScope;
}

Implemented by

Properties

conditions? delegated? description? id requester scope

Properties

Optional Readonly conditions

conditions?: PermissionConditions

Optional conditions that must be met when the requested grant is used.

Optional Readonly delegated

delegated?: boolean

Whether the requested grant is delegated or not. If true, the requestor will be able to act as the grantor of the permission within the scope of the requested grant.

Optional Readonly description

description?: string

Optional string that communicates what the requested grant would be used for.

Readonly id

id: string

The ID of the permission request, which is the record ID DWN message.

Readonly requester

requester: string

The requester for of the permission.

Readonly scope

scope: PermissionScope

The scope of the allowed access.

Settings

Member Visibility

Theme

On This Page

conditionsdelegateddescriptionidrequesterscope