Class ServiceAuthorization

Hierarchy

TagoIOModule<GenericModuleParams>
- ServiceAuthorization

Index

Constructors

Methods

tokenCreate tokenDelete tokenEdit tokenList

Constructors

constructor

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

Methods

tokenCreate

tokenCreate(tokenParams: TokenData): Promise<TokenCreateResponse>
Parameters
- tokenParams: TokenData
Returns Promise<TokenCreateResponse>
Description
Generates and retrieves a new service authorization token with specified permissions.

See
https://help.tago.io/portal/en/kb/articles/218-authorization Authorization
Example
If receive an error "Authorization Denied", check policy Service Authorization / Create in Access Management.
```
const result = await Resources.serviceAuthorization.tokenCreate({
  name: "Service Token",
  verification_code: "additional parameter"
});
console.log(result); // { token: 'token-xyz-123', name: 'Service Token', ... }
```
- Defined in modules/Resources/ServiceAuthorization.ts:56

tokenDelete

tokenDelete(token: string): Promise<string>
Parameters
- token: string
Returns Promise<string>
Description
Permanently removes a service authorization token.

See
https://help.tago.io/portal/en/kb/articles/218-authorization Authorization
Example
If receive an error "Authorization Denied", check policy Service Authorization / Delete in Access Management.
```
const result = await Resources.serviceAuthorization.tokenDelete("token-xyz-123");
console.log(result); // Token Successfully Removed
```
- Defined in modules/Resources/ServiceAuthorization.ts:78

tokenEdit

tokenEdit(token: string, verificationCode?: string): Promise<string>
Parameters
- token: string
- OptionalverificationCode: string
Returns Promise<string>
Description
Updates a service authorization token with an optional verification code.

See
https://help.tago.io/portal/en/kb/articles/218-authorization Authorization
Example
If receive an error "Authorization Denied", check policy Service Authorization / Edit in Access Management.
```
const result = await Resources.serviceAuthorization.tokenEdit("token-xyz-123", "verification-code");
console.log(result); // Authorization Code Successfully Updated
```
- Defined in modules/Resources/ServiceAuthorization.ts:99

tokenList

tokenList(query?: ListTokenQuery): Promise<Partial<TokenDataList>[]>
Parameters
- Optionalquery: ListTokenQuery
Returns Promise<Partial<TokenDataList>[]>
Description
Retrieves a paginated list of all service authorization tokens with filtering and sorting options.

See
https://help.tago.io/portal/en/kb/articles/218-authorization Authorization
Example
If receive an error "Authorization Denied", check policy Service Authorization / Access in Access Management.
```
const result = await Resources.serviceAuthorization.tokenList({
  page: 1,
  fields: ["name", "token"],
  amount: 20
});
console.log(result); // [ { name: 'API Service Token', token: 'token-xyz-123' } ]
```
- Defined in modules/Resources/ServiceAuthorization.ts:23