Class Access

Hierarchy

TagoIOModule<GenericModuleParams>
- Access

Index

Constructors

Methods

create delete edit info list

Constructors

constructor

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

Methods

create

create(accessObj): Promise<{
am_id: string;
}>
Create a new access policy
Parameters
- accessObj: AccessCreateInfo
Returns Promise<{
am_id: string;
}>
- Defined in modules/Resources/Access.ts:43

delete

delete(accessID): Promise<string>
Delete account policy
Parameters
- accessID: string
  
  Access policy identification
Returns Promise<string>
- Defined in modules/Resources/Access.ts:76

edit

edit(accessID, accessObj): Promise<string>
Edit access policy
Parameters
- accessID: string
  
  Access policy identification
- accessObj: Partial<AccessInfo>
  
  Access policy info to change
Returns Promise<string>
- Defined in modules/Resources/Access.ts:60

info

info(accessID): Promise<AccessInfo>
Get account policy info
Parameters
- accessID: string
  
  Access policy identification
Returns Promise<AccessInfo>
- Defined in modules/Resources/Access.ts:89

list

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