Nucleus .Net Core CMS

Models.ApiKey Class

Namespace: Nucleus.Abstractions.Models
Assembly: Nucleus.Abstractions.dll
Represents an API key which is used for authentication by API clients.


Id Property

API Key id

Name Property

API Key Name.
This value is used by admin pages to help identify the key.

Notes Property

API Key notes.
Use notes to record any other information about the usage or purpose of the API key.

Secret Property

API Key Secret. This value is used when encrypting API data.

Scope Property

API Key scope.
Space-separated list of scopes for the API key. Scopes represent the operations that the API key can be used for.

Enabled Property

Enabled flag.
Disabled Api Keys throw an "access denied" error if used.