Class BaseServiceTokensService<U, ST>

Type Parameters

U extends BaseUser = BaseUser
ST extends BaseServiceToken = BaseServiceToken

Index

Constructors

Properties

dataSource idService jwtConfig logger loggerFactory usersService

Accessors

Methods

create delete deleteAllByServiceAccountId generateEntityId getMany getOne getOneOrFail onModuleInit regenerate sync update

Constructors

constructor

new BaseServiceTokensService<
U extends BaseUser = BaseUser,
ST extends BaseServiceToken = BaseServiceToken,
>(): BaseServiceTokensService<U, ST>
Type Parameters
- U extends BaseUser = BaseUser
- ST extends BaseServiceToken = BaseServiceToken
Returns BaseServiceTokensService<U, ST>

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected` `Readonly`idService

idService: IdService

`Protected` `Readonly`jwtConfig

jwtConfig: JwtConfigType

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

`Protected` `Readonly`usersService

usersService: BaseUsersService<U>

Accessors

repository

get repository(): Repository<ST>
Returns Repository<ST>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:58

Methods

create

create(
input: CreateServiceTokenOptions,
ctx: BaseServiceMethodContext,
): Promise<CreateServiceTokenResult<ST>>
Create service token for service account
Parameters
- input: CreateServiceTokenOptions
- ctx: BaseServiceMethodContext
Returns Promise<CreateServiceTokenResult<ST>>
access token
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:76

delete

delete(id: string, ctx: BaseServiceMethodContext): Promise<void>
Delete service token from database
Parameters
- id: string
  id of service account
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:296

deleteAllByServiceAccountId

deleteAllByServiceAccountId(
serviceAccountId: string,
ctx: BaseServiceMethodContext,
): Promise<void>
Parameters
- serviceAccountId: string
- ctx: BaseServiceMethodContext
Returns Promise<void>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:315

`Protected`generateEntityId

generateEntityId(): string
Returns string
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:68

getMany

getMany(
__namedParameters: GetManyServiceTokensOptions,
): Promise<[ST[], ListMeta]>
Get service tokens list
Parameters
- __namedParameters: GetManyServiceTokensOptions
Returns Promise<[ST[], ListMeta]>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:181

getOne

getOne(id: string): Promise<MaybeNull<ST>>
Get service token by ID
Parameters
- id: string
  Service token ID
Returns Promise<MaybeNull<ST>>
Service token entity or null if not found
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:148

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<ST>
Get service token by ID or throw an exception if not found
Parameters
- id: string
  Service token ID
- ctx: BaseServiceMethodContext
  Service method context
Returns Promise<ST>
Service token entity or throws an exception if not found
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:160

onModuleInit

onModuleInit(): void
Returns void
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:62

regenerate

regenerate(
id: string,
ctx: BaseServiceMethodContext,
): Promise<RegenerateServiceTokenResult<ST>>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<RegenerateServiceTokenResult<ST>>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:245

sync

sync(opts: SyncServiceTokenOptions, ctx: BaseServiceMethodContext): Promise<ST>
Sync service token
Parameters
- opts: SyncServiceTokenOptions
  options to sync service token
- ctx: BaseServiceMethodContext
  service method context
Returns Promise<ST>
- synced service token
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:264

update

update(
__namedParameters: UpdateServiceTokenOptions,
ctx: BaseServiceMethodContext,
): Promise<ST>
Parameters
- __namedParameters: UpdateServiceTokenOptions
- ctx: BaseServiceMethodContext
Returns Promise<ST>
- Defined in src/modules/service-accounts/service-tokens/service-tokens.service.ts:217