grafana/kinds/serviceaccount/serviceaccount_kind.cue
Ryan McKinley 0f0a53fbbb
Schemas: Add description to kinds metadata (#62638)
* add description to kinds

* omit empty
2023-01-31 17:54:22 -05:00

48 lines
1.8 KiB
CUE

package kind
name: "ServiceAccount"
maturity: "merged"
description: "system account"
lineage: seqs: [
{
schemas: [
// v0.0
{
// ID is the unique identifier of the service account in the database.
id: int64 @grafanamaturity(ToMetadata="sys")
// OrgId is the ID of an organisation the service account belongs to.
orgId: int64 @grafanamaturity(ToMetadata="sys")
// Name of the service account.
name: string
// Login of the service account.
login: string
// IsDisabled indicates if the service account is disabled.
isDisabled: bool
// Role is the Grafana organization role of the service account which can be 'Viewer', 'Editor', 'Admin'.
role: #OrgRole @grafanamaturity(ToMetadata="kind")
// Tokens is the number of active tokens for the service account.
// Tokens are used to authenticate the service account against Grafana.
tokens: int64 @grafanamaturity(ToMetadata="kind")
// AvatarUrl is the service account's avatar URL. It allows the frontend to display a picture in front
// of the service account.
avatarUrl: string @grafanamaturity(ToMetadata="kind")
// AccessControl metadata associated with a given resource.
accessControl?: {
[string]: bool @grafanamaturity(ToMetadata="sys")
}
// Teams is a list of teams the service account belongs to.
teams?: [...string] @grafanamaturity(ToMetadata="sys")
// Created indicates when the service account was created.
created?: int64 @grafanamaturity(ToMetadata="sys")
// Updated indicates when the service account was updated.
updated?: int64 @grafanamaturity(ToMetadata="sys")
// OrgRole is a Grafana Organization Role which can be 'Viewer', 'Editor', 'Admin'.
#OrgRole: "Admin" | "Editor" | "Viewer" @cuetsy(kind="type")
},
]
},
]