Class ServiceAuthorization

Hierarchy

TagoIOModule<GenericModuleParams>
- ServiceAuthorization

Index

Constructors

Methods

tokenCreate tokenDelete tokenEdit tokenList

Constructors

constructor

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

Methods

tokenCreate

tokenCreate(tokenParams): Promise<TokenCreateResponse>
Generates and retrieves a new token
Parameters
- tokenParams: TokenData
  Token params to create new token
Returns Promise<TokenCreateResponse>
- Defined in modules/Resources/ServiceAuthorization.ts:40

tokenDelete

tokenDelete(token): Promise<string>
Deletes a token
Parameters
- token: string
  Token
Returns Promise<string>
- Defined in modules/Resources/ServiceAuthorization.ts:56

tokenEdit

tokenEdit(token, verificationCode?): Promise<string>
Parameters
- token: string
- Optional verificationCode: string
Returns Promise<string>
- Defined in modules/Resources/ServiceAuthorization.ts:65

tokenList

tokenList(query?): Promise<Partial<TokenDataList>[]>
Retrieves a list of all tokens
Parameters
- Optional query: ListTokenQuery
  Search query params
Returns Promise<Partial<TokenDataList>[]>
Example
```
Default Query: {
  page: 1,
  fields: ["name", "token", "permission"],
  filter: {},
  amount: 20,
  orderBy: "created_at,desc",
}
```
- Defined in modules/Resources/ServiceAuthorization.ts:18