API Keys

The API requests must be authenticated by the CometChat server. To do this you need to generate the apiKeys and use it for making network calls.

The following table lists the properties that the APIKey API supports.

Parameters

Type

Description

name

string

  • (mandatory)_ Specifies the name of the apiKey.
    Maximum length is 50 characters.

scope

string

  • (optional)_ Specifies the scope of the apiKey. Possible values:
    fullAccess, authOnly.\

The authOnly key can be used to create & login users. Recommended to use in client-side code during development.
The fullAccess key can be used to perform any CometChat operation usually in your server-side code.

apiKey

string

apiKey used for authentication. character length - 40

createdAt

integer

UNIX Timestamp indicating the time when the apiKey was created