Class Permission

Use to read, replace, or delete a given Permission by id.

see: Permissions to create, upsert, query, or read all Permissions.

Hierarchy

Permission

Index

Properties

id
user

Accessors

url

Methods

Properties

id

id: string

The id of the given Permission.

user

user: User

The parent User.

Accessors

url

get url(): string

- Defined in client/Permission/Permission.ts:18
Returns a reference URL to the resource. Used for linking in Permissions.

Returns string

Methods

delete

delete(options?: RequestOptions): Promise<PermissionResponse>

- Defined in client/Permission/Permission.ts:73
Delete the given Permission.

Parameters
- Optional options: RequestOptions
Returns Promise<PermissionResponse>

read

read(options?: RequestOptions): Promise<PermissionResponse>

- Defined in client/Permission/Permission.ts:32
Read the PermissionDefinition of the given Permission.

Parameters
- Optional options: RequestOptions
Returns Promise<PermissionResponse>

replace

replace(body: PermissionDefinition, options?: RequestOptions): Promise<PermissionResponse>

- Defined in client/Permission/Permission.ts:50
Replace the given Permission with the specified PermissionDefinition.

Parameters
- body: PermissionDefinition
  
  The specified PermissionDefinition.
- Optional options: RequestOptions
Returns Promise<PermissionResponse>

Generated using TypeDoc