Class S2AccessTokens

constructor

• new S2AccessTokens(client: Client, retryConfig?: RetryConfig): S2AccessTokens

  Parameters

  • client: Client
  • OptionalretryConfig: RetryConfig

  Returns S2AccessTokens

Readonlyclient

issue

• issue(
      args: IssueAccessTokenInput,
      options?: S2RequestOptions,
  ): Promise<IssueAccessTokenResponse>

  Issue a new access token.

  Parameters

  • args: IssueAccessTokenInput

    Input for issuing an access token.

    • OptionalautoPrefixStreams?: boolean

      Namespace streams based on the configured stream-level scope, which must be a prefix. Stream name arguments will be automatically prefixed, and the prefix will be stripped when listing streams.

    • OptionalexpiresAt?: string | number | Date

      Expiration time (Date, milliseconds since Unix epoch, or RFC 3339 string). If not set, the expiration will be set to that of the requestor's token.

    • id: string

      Access token ID. It must be unique to the account and between 1 and 96 bytes in length.

    • scope: AccessTokenScope

      Access token scope.

  • Optionaloptions: S2RequestOptions

  Returns Promise<IssueAccessTokenResponse>

list

• list(
      args?: ListAccessTokensInput,
      options?: S2RequestOptions,
  ): Promise<ListAccessTokensResponse>

  List access tokens.

  Parameters

  • Optionalargs: ListAccessTokensInput

    Input for listing access tokens.

    • Optionallimit?: number

      Number of results, up to a maximum of 1000.

    • Optionalprefix?: string

      Filter to access tokens whose ID begins with this prefix.

    • OptionalstartAfter?: string

      Filter to access tokens whose ID lexicographically starts after this string.

  • Optionaloptions: S2RequestOptions

  Returns Promise<ListAccessTokensResponse>

listAll

• listAll(
      args?: ListAllAccessTokensInput,
      options?: S2RequestOptions,
  ): AsyncIterable<AccessTokenInfo>

  List all access tokens with automatic pagination. Returns a lazy async iterable that fetches pages as needed.

  Parameters

  • Optionalargs: ListAllAccessTokensInput

    Optional filtering options: prefix to filter by ID prefix, limit for max results per page

  • Optionaloptions: S2RequestOptions

  Returns AsyncIterable<AccessTokenInfo>

  Example

  for await (const token of s2.accessTokens.listAll({ prefix: "service-" })) {
    console.log(token.id);
  }
  Copy

revoke

• revoke(args: RevokeAccessTokenInput, options?: S2RequestOptions): Promise<void>

  Revoke an access token by ID.

  Parameters

  • args: RevokeAccessTokenInput

    Input for revoking an access token.

    • id: string

      Access token ID.

  • Optionaloptions: S2RequestOptions

  Returns Promise<void>