Models.ApiKey Class
Namespace: Nucleus.Abstractions.Models
Assembly: Nucleus.Abstractions.dll
Represents an API key which is used for authentication by API clients.
Properties
Enabled Property
Enabled flag.
Remarks
Disabled Api Keys throw an "access denied" error if used.
Id Property
API Key id
Name Property
API Key Name.
Remarks
This value is used by admin pages to help identify the key.
Notes Property
API Key notes.
Remarks
Use notes to record any other information about the usage or purpose of the API key.
Scope Property
API Key scope.
Remarks
Space-separated list of scopes for the API key. Scopes represent the operations that the API key can be used for.
Secret Property
API Key Secret. This value is used when encrypting API data.