VCA super admin

Admin help

One sentence, four places

Each sentence below comes from the description option of the RPC in the proto file. The CLI help, the man pages, this page, and the OpenAPI document read the same source.

Commands, 22 found
CommandWhat it doesRPCFlags
admin tenant createCreates one tenant.AdminService.CreateTenant--name (required)
admin tenant getReturns one tenant by id.AdminService.GetTenant--id (required)
admin tenant listReturns tenants in pages.AdminService.ListTenants--page-size, --page-token
admin tenant updateChanges the display name or the state of one tenant.AdminService.UpdateTenant--id (required), --name, --state
admin tenant deleteRemoves one tenant and every record it owns.AdminService.DeleteTenant--id (required)
admin trust addCreates or replaces one trust entry.AdminService.UpsertTrustEntry--did, --x509-subject, --name (required), --role (required), --status, --credential-type, --service-endpoint
admin trust getReturns one trust entry by entity identifier.AdminService.GetTrustEntry--did, --x509-subject
admin trust listReturns trust entries in pages.AdminService.ListTrustEntries--role, --page-size, --page-token
admin trust removeRemoves one trust entry.AdminService.DeleteTrustEntry--did, --x509-subject
admin onboardRegisters one OIDC provider.AdminService.CreateAuthProvider--issuer (required), --name, --client-id, --client-secret-env, --dynamic, --initial-access-token, --roles-claim-path
admin onboard-providerRegisters one OIDC provider from its issuer URL.AdminService.OnboardProvider--issuer-url (required), --client-id, --client-secret-env, --dynamic
admin provider getReturns one provider by id.AdminService.GetAuthProvider--id (required)
admin provider listReturns providers in pages.AdminService.ListAuthProviders--page-size, --page-token
admin provider updateChanges one provider.AdminService.UpdateAuthProvider--id (required), --name, --enabled
admin provider removeRemoves one provider.AdminService.DeleteAuthProvider--id (required)
admin apikey createCreates one machine API key.AdminService.CreateApiKey--name (required), --tenant (required), --role (required), --expires
admin apikey listReturns API keys without their secret values.AdminService.ListApiKeys--tenant, --page-size
admin apikey revokeDisables one API key at once.AdminService.RevokeApiKey--id (required)
admin healthReturns the health of every service in the deployment.AdminService.GetServiceHealthNone
admin auditReturns audit records that match a filter, newest first.AdminService.QueryAuditLog--actor, --action, --from, --to, --page-size
admin bindBinds the first super admin with the bootstrap token.AdminService.OnboardAdmin--bootstrap-token (required), --provider
admin helpReturns the command tree with descriptions.AdminService.ListCommandsNone
RPCs, 22 found
RPCWhat it does
CreateTenantCreates one tenant.
GetTenantReturns one tenant by id.
ListTenantsReturns tenants in pages.
UpdateTenantChanges the display name or the state of one tenant.
DeleteTenantRemoves one tenant and every record it owns.
UpsertTrustEntryCreates or replaces one trust entry.
GetTrustEntryReturns one trust entry by entity identifier.
ListTrustEntriesReturns trust entries in pages.
DeleteTrustEntryRemoves one trust entry.
CreateAuthProviderRegisters one OIDC provider.
GetAuthProviderReturns one provider by id.
ListAuthProvidersReturns providers in pages.
UpdateAuthProviderChanges one provider.
DeleteAuthProviderRemoves one provider.
OnboardProviderRegisters one OIDC provider from its issuer URL.
CreateApiKeyCreates one machine API key.
ListApiKeysReturns API keys without their secret values.
RevokeApiKeyDisables one API key at once.
GetServiceHealthReturns the health of every service in the deployment.
QueryAuditLogReturns audit records that match a filter, newest first.
OnboardAdminBinds the first super admin with the bootstrap token.
ListCommandsReturns the command tree with descriptions.