ApiKey interface
An API key used for authenticating with a configuration store endpoint.
Properties
connection |
A connection string that can be used by supporting clients for authentication. NOTE: This property will not be serialized. It can only be populated by the server. |
id | The key ID. NOTE: This property will not be serialized. It can only be populated by the server. |
last |
The last time any of the key's properties were modified. NOTE: This property will not be serialized. It can only be populated by the server. |
name | A name for the key describing its usage. NOTE: This property will not be serialized. It can only be populated by the server. |
read |
Whether this key can only be used for read operations. NOTE: This property will not be serialized. It can only be populated by the server. |
value | The value of the key that is used for authentication purposes. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
connectionString
A connection string that can be used by supporting clients for authentication. NOTE: This property will not be serialized. It can only be populated by the server.
connectionString?: string
Property Value
string
id
The key ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
lastModified
The last time any of the key's properties were modified. NOTE: This property will not be serialized. It can only be populated by the server.
lastModified?: Date
Property Value
Date
name
A name for the key describing its usage. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
readOnly
Whether this key can only be used for read operations. NOTE: This property will not be serialized. It can only be populated by the server.
readOnly?: boolean
Property Value
boolean
value
The value of the key that is used for authentication purposes. NOTE: This property will not be serialized. It can only be populated by the server.
value?: string
Property Value
string