Class Access

Hierarchy

TagoIOModule<GenericModuleParams>
- Access

Index

Constructors

constructor

Methods

Constructors

constructor

new Access(params: GenericModuleParams): Access

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Access

Methods

create

create(accessObj: AccessCreateInfo): Promise<{ am_id: string }>

- Defined in src/modules/Account/Access.ts:43
Create a new access policy

Parameters
- accessObj: AccessCreateInfo
Returns Promise<{ am_id: string }>

delete

delete(accessID: string): Promise<string>

- Defined in src/modules/Account/Access.ts:76
Delete account policy

Parameters
- accessID: string
  
  Access policy identification
Returns Promise<string>

edit

edit(accessID: string, accessObj: Partial<AccessInfo>): Promise<string>

- Defined in src/modules/Account/Access.ts:60
Edit access policy

Parameters
- accessID: string
  
  Access policy identification
- accessObj: Partial<AccessInfo>
  
  Access policy info to change
Returns Promise<string>

info

info(accessID: string): Promise<AccessInfo>

- Defined in src/modules/Account/Access.ts:89
Get account policy info

Parameters
- accessID: string
  
  Access policy identification
Returns Promise<AccessInfo>

list

list(queryObj?: AccessQuery): Promise<AccessInfo[]>

- Defined in src/modules/Account/Access.ts:21
Retrieves a list with all Access rules from account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name", "tags"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: AccessQuery
  
  Search query params
Returns Promise<AccessInfo[]>