Interface ExternalUserKey
interface ExternalUserKey {
id: string;
name: string;
valuePrefix: string;
roles: readonly string[];
scopes: readonly string[];
validUntil: Date | null;
}
id: string;
name: string;
valuePrefix: string;
roles: readonly string[];
scopes: readonly string[];
validUntil: Date | null;
}
Properties
Readonlyid
id: string
The handle addressing the key, for deleting it.
Readonlyname
name: string
The key's name. Empty when none was given.
ReadonlyvaluePrefix
valuePrefix: string
The first characters of the key's value, to recognise it by.
Readonlyroles
roles: readonly string[]
The content roles the key carries.
Readonlyscopes
scopes: readonly string[]
The scopes the key grants.
ReadonlyvalidUntil
validUntil: Date | null
When the key expires, or null when the service reported no expiry.
An external user's API key, described without its value.