IApiKeyResponse

Interface

Return value of createApiKey, getApiKey, updateApiKey representing an API Key entity. accessToken1/accessToken2 properties are only available when generateToken1/generateToken2 are true.

Inheritance: IApiKeyResponseIApiKeyInfo

Properties

Hide inherited properties
PropertyTypeNotes
string
string
apiKey
inherited
string

Only to be present if appType is apikey

boolean
boolean
client_id
inherited
string
httpReferrers
inherited
string[]
boolean

Represent item info attached to this API Key.

itemId
inherited
string
modified
inherited
Date
privileges
inherited
string[]
registered
inherited
Date

accessToken1

optional
Interface Property
accessToken1: string

accessToken2

optional
Interface Property
accessToken2: string

apiKey

optionalinherited
Interface Property
apiKey: string

Only to be present if appType is apikey

Inherited from IApiKeyInfo.apiKey

apiToken1Active

inherited
Interface Property
apiToken1Active: boolean

apiToken2Active

inherited
Interface Property
apiToken2Active: boolean

client_id

inherited
Interface Property
client_id: string
Inherited from IApiKeyInfo.client_id

httpReferrers

inherited
Interface Property
httpReferrers: string[]

isPersonalAPIToken

inherited
Interface Property
isPersonalAPIToken: boolean

item

Interface Property
item: IItem

Represent item info attached to this API Key.

itemId

inherited
Interface Property
itemId: string
Inherited from IApiKeyInfo.itemId

modified

inherited
Interface Property
modified: Date
Inherited from IApiKeyInfo.modified

privileges

inherited
Interface Property
privileges: string[]
Inherited from IApiKeyInfo.privileges

registered

inherited
Interface Property
registered: Date
Inherited from IApiKeyInfo.registered

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.