Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiKeysApi

ApiKeysApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

createApiKey

createApiKeyAdmin

  • Create a new API key for any user in your organization. Accessible to Admin users only.

    summary

    Create API Key (any user)

    throws

    {RequiredError}

    memberof

    ApiKeysApi

    Parameters

    Returns Promise<CreateApiKeyResponse>

deleteApiKey

  • Delete an API key for the authenticated user.

    summary

    Delete API Key

    throws

    {RequiredError}

    memberof

    ApiKeysApi

    Parameters

    • name: string

      name of the API key

    • Optional options: any

    Returns Promise<DeleteApiKeyResponse>

deleteApiKeyAdmin

  • Delete an API key for any user in your organization. Accessible to Admin users only.

    summary

    Delete API Key (any user)

    throws

    {RequiredError}

    memberof

    ApiKeysApi

    Parameters

    • name: string

      name of the API key

    • user: string

      user email

    • Optional options: any

    Returns Promise<DeleteApiKeyResponse>

listApiKeys

  • List all API keys for the authenticated user.

    summary

    List API Keys

    throws

    {RequiredError}

    memberof

    ApiKeysApi

    Parameters

    • Optional options: any

    Returns Promise<ListApiKeysResponse>

listApiKeysAdmin

  • List all API keys for any user in your organization. Accessible to Admin users only.

    summary

    List API Keys (any user)

    throws

    {RequiredError}

    memberof

    ApiKeysApi

    Parameters

    • user: string

      user email

    • Optional options: any

    Returns Promise<ListApiKeysResponse>

Generated using TypeDoc