Account
| API version | kobblestone.io/v1alpha1 |
|---|---|
| Kind | Account |
| Scope | Namespaced |
| kubectl | kubectl get accounts |
Account represents a Microsoft account that can be used to authenticate against online Minecraft servers. They can be referenced by Bots to connect to online servers.
Once an Account is created, an authorization flow (OAuth device flow) is initiated. The field status.deviceFlow will contain all necessary information for users to complete the authorization.
Once authorization is completed, the session is stored in the Secret named like the Account (type kobblestone.io/minecraft-session) in a standard, client independent format, so it can be mounted by any workload. The refresh token is kept separately in the internal <account>-credentials Secret.
Accounts automatically refresh their session before it expires for as long as the authorization state is valid.
spec
authorizationobjectConfigurations related to the authorization flows.
1 field
podobjectConfigures the managed Pod resource that is spawned for authorization flows.
6 fields
affinityobjectAffinity of the authorization Pod.
3 fields
nodeAffinityobject2 fields
1 field
nodeSelectorTerms[]objectpodAffinityobject2 fields
2 fields
podAffinityTermobject6 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringweightint326 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringpodAntiAffinityobject2 fields
2 fields
podAffinityTermobject6 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringweightint326 fields
labelSelectorobjectmatchLabelKeys[]stringmismatchLabelKeys[]stringnamespaceSelectorobjectnamespaces[]stringtopologyKeystringimagestringCustom image for the authorization container.
Default is ghcr.io/kobblestoneio/account-auth (Kobblestone.AccountAuth).
inactivebooleanWhether this account is considered inactive and will not attempt any authorization.
Inactive accounts will permanently stay in phase Unauthorized.
Default is false.
Configures the max. leftover TTL of sessions in minutes before they are refreshed.
Default is 60 (1 hour).
- Minimum: 5
status
authorizedAtstringTimestamp when this Account was last authorized and a session was created.
- Format:
date-time
conditions[]objectConditions of the Account.
6 fields
lastTransitionTimestring- Format:
date-time
messagestringobservedGenerationint64reasonstringstatusstringtypestringdeviceFlowobjectContains information for completing the device flow authorization.
Only set when status.phase is AwaitingAuthorization.
4 fields
messagestringMessage that can be shown to the human from whom action is required.
Code with which the flow may be authorized.
messagestringMessage explaining the current state of the Account.
phasestringCurrent phase of the Account.
Values:
Unauthorized: TheAccountis not authorized and is currently not awaiting authorization.AwaitingAuthorization: TheAccountawaits manual authorization via the device flow.Authorized: TheAccountwas successfully authorized and is considered ready.
- One of:
Unauthorized,AwaitingAuthorization,Authorized
profileobjectContains user profile information.
Only set when status.phase is Authorized.