Interface IApiAccessTokenService

Service for managing API access tokens.

interface IApiAccessTokenService {
    create(
        request: ApiAccessTokenNewRequest,
    ): Promise<ApiAccessTokenNewResponse>;
    get(request: ApiAccessTokenGetRequest): Promise<ApiAccessTokenGetResponse>;
    revoke(
        request: ApiAccessTokenDeleteRequest,
    ): Promise<ApiAccessTokenDeleteResponse>;
    view(
        request: ApiAccessTokenViewRequest,
    ): Promise<ApiAccessTokenViewResponse>;
}

Implemented by

ApiAccessTokenService

Index

Methods

create get revoke view

Methods

create

create(request: ApiAccessTokenNewRequest): Promise<ApiAccessTokenNewResponse>
Creates and returns a new API access token.
Parameters
- request: ApiAccessTokenNewRequest
  Request to create API access token.
Returns Promise<ApiAccessTokenNewResponse>
Response to API access token create request.
- Defined in @tessa/platform/src/tokens/api/apiAccessTokenTypes.ts:17

get

get(request: ApiAccessTokenGetRequest): Promise<ApiAccessTokenGetResponse>
Retrieves an existing API access token.
Parameters
- request: ApiAccessTokenGetRequest
  Request to retrieve API access token.
Returns Promise<ApiAccessTokenGetResponse>
Response to API access token retrieve request.
- Defined in @tessa/platform/src/tokens/api/apiAccessTokenTypes.ts:24

revoke

revoke(
request: ApiAccessTokenDeleteRequest,
): Promise<ApiAccessTokenDeleteResponse>
Revokes an existing API access token.
Parameters
- request: ApiAccessTokenDeleteRequest
  Request to delete API access token.
Returns Promise<ApiAccessTokenDeleteResponse>
Response to API access token delete request.
- Defined in @tessa/platform/src/tokens/api/apiAccessTokenTypes.ts:38

view

view(request: ApiAccessTokenViewRequest): Promise<ApiAccessTokenViewResponse>
Retrieves a collection of existing API access tokens.
Parameters
- request: ApiAccessTokenViewRequest
  Request to retrieve API access token with sorting options.
Returns Promise<ApiAccessTokenViewResponse>
Response to API access token view request.
- Defined in @tessa/platform/src/tokens/api/apiAccessTokenTypes.ts:31