Class PermissionsProtocol

constructor

• new PermissionsProtocol(): PermissionsProtocol

• Returns PermissionsProtocol

Static Readonlydefinition

Static ReadonlygrantPath

Static ReadonlyrequestPath

Static ReadonlyrevocationPath

Static Readonlyuri

StaticcreateGrant

• createGrant(options): Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionGrantBytes: Uint8Array;
      permissionGrantData: PermissionGrantData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission grant.

  Parameters

  • options: PermissionGrantCreateOptions

  Returns Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionGrantBytes: Uint8Array;
      permissionGrantData: PermissionGrantData;
      recordsWrite: RecordsWrite;
  }>

StaticcreateRequest

• createRequest(options): Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionRequestBytes: Uint8Array;
      permissionRequestData: PermissionRequestData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission request.

  Parameters

  • options: PermissionRequestCreateOptions

  Returns Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionRequestBytes: Uint8Array;
      permissionRequestData: PermissionRequestData;
      recordsWrite: RecordsWrite;
  }>

StaticcreateRevocation

• createRevocation(options): Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionRevocationBytes: Uint8Array;
      permissionRevocationData: PermissionRevocationData;
      recordsWrite: RecordsWrite;
  }>

• Convenience method to create a permission revocation.

  Parameters

  • options: PermissionRevocationCreateOptions

  Returns Promise<{
      dataEncodedMessage: DataEncodedRecordsWriteMessage;
      permissionRevocationBytes: Uint8Array;
      permissionRevocationData: PermissionRevocationData;
      recordsWrite: RecordsWrite;
  }>

StaticfetchGrant

• fetchGrant(tenant, messageStore, permissionGrantId): Promise<PermissionGrant>

• Fetches PermissionGrant with the specified recordID.

  Parameters

  • tenant: string
  • messageStore: MessageStore
  • permissionGrantId: string

  Returns Promise<PermissionGrant>

  the PermissionGrant matching the recordId specified.

  Throws

  if PermissionGrant does not exist

StaticgetScopeFromPermissionRecord

• getScopeFromPermissionRecord(tenant, messageStore, incomingMessage): Promise<PermissionScope>

• Gets the scope from the given permission record. If the record is a revocation, the scope is fetched from the grant that is being revoked.

  Parameters

  • tenant: string
  • messageStore: MessageStore

    The message store to fetch the grant for a revocation.
  • incomingMessage: DataEncodedRecordsWriteMessage

  Returns Promise<PermissionScope>

StatichasProtocolScope

• hasProtocolScope(scope): scope is PermissionScope & {
      protocol: string;
  }

• Type guard to determine if the permission is a protocol-scoped

  Parameters

  • scope: PermissionScope

  Returns scope is PermissionScope & {
      protocol: string;
  }

StaticparseRequest

• parseRequest(base64UrlEncodedRequest): PermissionRequestData

• Parameters

  • base64UrlEncodedRequest: string

  Returns PermissionRequestData

StaticvalidateSchema

• validateSchema(recordsWriteMessage, dataBytes): void

• Validates the given Permissions protocol RecordsWrite. It can be a request, grant, or revocation.

  Parameters

  • recordsWriteMessage: RecordsWriteMessage
  • dataBytes: Uint8Array

  Returns void