display

package
v1.25.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2025 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const (
	MetricSuccessfulDeliveries = "auth0.event_streams.successful_deliveries"
	MetricFailedDeliveries     = "auth0.event_streams.failed_deliveries"
)

Variables

View Source
var SupportedTenantSettings = map[string]string{
	"EnableClientConnections":                        "flags.enable_client_connections",
	"EnableAPIsSection":                              "flags.enable_apis_section",
	"EnablePipeline2":                                "flags.enable_pipeline2",
	"EnableDynamicClientRegistration":                "flags.enable_dynamic_client_registration",
	"EnableCustomDomainInEmails":                     "flags.enable_custom_domain_in_emails",
	"EnableSSO":                                      "flags.enable_sso",
	"AllowChangingEnableSSO":                         "flags.allow_changing_enable_sso",
	"UniversalLogin":                                 "flags.universal_login",
	"EnableLegacyLogsSearchV2":                       "flags.enable_legacy_logs_search_v2",
	"DisableClickjackProtectionHeaders":              "flags.disable_clickjack_protection_headers",
	"EnablePublicSignupUserExistsError":              "flags.enable_public_signup_user_exists_error",
	"UseScopeDescriptionsForConsent":                 "flags.use_scope_descriptions_for_consent",
	"AllowLegacyDelegationGrantTypes":                "flags.allow_legacy_delegation_grant_types",
	"AllowLegacyROGrantTypes":                        "flags.allow_legacy_ro_grant_types",
	"AllowLegacyTokenInfoEndpoint":                   "flags.allow_legacy_tokeninfo_endpoint",
	"EnableLegacyProfile":                            "flags.enable_legacy_profile",
	"EnableIDTokenAPI2":                              "flags.enable_idtoken_api2",
	"NoDisclosureEnterpriseConnections":              "flags.no_disclose_enterprise_connections",
	"DisableManagementAPISMSObfuscation":             "flags.disable_management_api_sms_obfuscation",
	"EnableADFSWAADEmailVerification":                "flags.enable_adfs_waad_email_verification",
	"RevokeRefreshTokenGrant":                        "flags.revoke_refresh_token_grant",
	"DashboardLogStreams":                            "flags.dashboard_log_streams_next",
	"DashboardInsightsView":                          "flags.dashboard_insights_view",
	"DisableFieldsMapFix":                            "flags.disable_fields_map_fix",
	"MFAShowFactorListOnEnrollment":                  "flags.mfa_show_factor_list_on_enrollment",
	"RemoveAlgFromJWKS":                              "flags.remove_alg_from_jwks",
	"CustomizeMFAInPostLoginAction":                  "customize_mfa_in_postlogin_action",
	"AllowOrgNameInAuthAPI":                          "allow_organization_name_in_authentication_api",
	"PushedAuthorizationRequestsSupported":           "pushed_authorization_requests_supported",
	"OIDCLogout.RPLogoutEndSessionEndpointDiscovery": "oidc_logout.rp_logout_end_session_endpoint_discovery",
	"MTLS.EnableEndpointAliases":                     "mtls.enable_endpoint_aliases",
}

Functions

func ApplyColorToFriendlyAppType added in v1.0.0

func ApplyColorToFriendlyAppType(a string) string

func FriendlyAppType added in v1.0.0

func FriendlyAppType(appType string) string

Types

type LogView added in v1.13.0

type LogView struct {
	*management.Log
	// contains filtered or unexported fields
}

func (*LogView) AsTableHeader added in v1.13.0

func (v *LogView) AsTableHeader() []string

func (*LogView) AsTableHeaderString added in v1.13.0

func (v *LogView) AsTableHeaderString() string

func (*LogView) AsTableRow added in v1.13.0

func (v *LogView) AsTableRow() []string

func (*LogView) AsTableRowString added in v1.13.0

func (v *LogView) AsTableRowString() string

func (*LogView) Extras added in v1.13.0

func (v *LogView) Extras() []string

func (*LogView) Object added in v1.13.0

func (v *LogView) Object() interface{}

type OutputFormat

type OutputFormat string
const (
	OutputFormatJSON        OutputFormat = "json"
	OutputFormatJSONCompact OutputFormat = "json-compact"
	OutputFormatCSV         OutputFormat = "csv"
)

type Renderer

type Renderer struct {
	Tenant string

	// MessageWriter receives the renderer messages (typically os.Stderr).
	MessageWriter io.Writer

	// ResultWriter writes the final result of the commands (typically os.Stdout which can be piped to other commands).
	ResultWriter io.Writer

	// Format indicates how the results are rendered. Default (empty) will write as table.
	Format OutputFormat
}

func NewRenderer

func NewRenderer() *Renderer

func (*Renderer) ACULConfigList added in v1.24.0

func (r *Renderer) ACULConfigList(aculConfigs *management.PromptRenderingList)

func (*Renderer) APICreate added in v1.0.0

func (r *Renderer) APICreate(api *management.ResourceServer)

func (*Renderer) APIList added in v1.0.0

func (r *Renderer) APIList(apis []*management.ResourceServer)

func (*Renderer) APIShow added in v1.0.0

func (r *Renderer) APIShow(api *management.ResourceServer, jsonFlag bool)

func (*Renderer) APIUpdate added in v1.0.0

func (r *Renderer) APIUpdate(api *management.ResourceServer)

func (*Renderer) ActionCreate added in v0.9.0

func (r *Renderer) ActionCreate(action *management.Action)

func (*Renderer) ActionDeploy added in v0.11.5

func (r *Renderer) ActionDeploy(action *management.Action)

func (*Renderer) ActionList

func (r *Renderer) ActionList(actions []*management.Action)

func (*Renderer) ActionShow added in v0.9.0

func (r *Renderer) ActionShow(action *management.Action)

func (*Renderer) ActionUpdate added in v0.9.0

func (r *Renderer) ActionUpdate(action *management.Action)

func (*Renderer) ApplicationCreate

func (r *Renderer) ApplicationCreate(client *management.Client, revealSecrets bool)

func (*Renderer) ApplicationList

func (r *Renderer) ApplicationList(clients []*management.Client, revealSecrets bool)

func (*Renderer) ApplicationShow

func (r *Renderer) ApplicationShow(client *management.Client, revealSecrets bool)

func (*Renderer) ApplicationUpdate

func (r *Renderer) ApplicationUpdate(client *management.Client, revealSecrets bool)

func (*Renderer) BrandingShow added in v0.8.0

func (r *Renderer) BrandingShow(data *management.Branding)

func (*Renderer) BrandingTextShow added in v0.11.3

func (r *Renderer) BrandingTextShow(brandingTextJSON, prompt, language string)

func (*Renderer) BrandingTextUpdate added in v0.11.3

func (r *Renderer) BrandingTextUpdate(brandingTextJSON string, prompt, language string)

func (*Renderer) BrandingUpdate added in v0.8.0

func (r *Renderer) BrandingUpdate(data *management.Branding)

func (*Renderer) BreachedPasswordDetectionShow added in v0.11.7

func (r *Renderer) BreachedPasswordDetectionShow(bpd *management.BreachedPasswordDetection)

func (*Renderer) BreachedPasswordDetectionUpdate added in v0.11.7

func (r *Renderer) BreachedPasswordDetectionUpdate(bpd *management.BreachedPasswordDetection)

func (*Renderer) BruteForceProtectionShow added in v0.11.7

func (r *Renderer) BruteForceProtectionShow(bfp *management.BruteForceProtection)

func (*Renderer) BruteForceProtectionUpdate added in v0.11.7

func (r *Renderer) BruteForceProtectionUpdate(bfp *management.BruteForceProtection)

func (*Renderer) ConfirmPrompt added in v1.19.0

func (r *Renderer) ConfirmPrompt(prompt string) bool

func (*Renderer) CustomDomainCreate added in v0.8.1

func (r *Renderer) CustomDomainCreate(customDomain *management.CustomDomain)

func (*Renderer) CustomDomainList added in v0.8.1

func (r *Renderer) CustomDomainList(customDomains []*management.CustomDomain)

func (*Renderer) CustomDomainShow added in v0.8.1

func (r *Renderer) CustomDomainShow(customDomain *management.CustomDomain)

func (*Renderer) CustomDomainUpdate added in v0.9.0

func (r *Renderer) CustomDomainUpdate(customDomain *management.CustomDomain)

func (*Renderer) EmailProviderCreate added in v1.8.0

func (r *Renderer) EmailProviderCreate(emailProvider *management.EmailProvider) error

func (*Renderer) EmailProviderShow added in v1.8.0

func (r *Renderer) EmailProviderShow(emailProvider *management.EmailProvider) error

func (*Renderer) EmailProviderUpdate added in v1.8.0

func (r *Renderer) EmailProviderUpdate(emailProvider *management.EmailProvider) error

func (*Renderer) EmailTemplateShow added in v0.9.1

func (r *Renderer) EmailTemplateShow(email *management.EmailTemplate)

func (*Renderer) EmailTemplateUpdate added in v0.9.1

func (r *Renderer) EmailTemplateUpdate(email *management.EmailTemplate)

func (*Renderer) EmptyState added in v0.3.1

func (r *Renderer) EmptyState(resource string, hint string)

func (*Renderer) Errorf

func (r *Renderer) Errorf(format string, a ...interface{})

func (*Renderer) EventDeliveriesList added in v1.19.0

func (r *Renderer) EventDeliveriesList(deliveries []*management.EventDelivery) error

func (*Renderer) EventDeliveryPrompt added in v1.19.0

func (r *Renderer) EventDeliveryPrompt(deliveries []*management.EventDelivery, currentIndex *int) *management.EventDelivery

func (*Renderer) EventStreamCreate added in v1.9.0

func (r *Renderer) EventStreamCreate(eventStream *management.EventStream) error

func (*Renderer) EventStreamShow added in v1.9.0

func (r *Renderer) EventStreamShow(eventStream *management.EventStream) error

func (*Renderer) EventStreamUpdate added in v1.9.0

func (r *Renderer) EventStreamUpdate(eventStream *management.EventStream) error

func (*Renderer) EventStreamsList added in v1.9.0

func (r *Renderer) EventStreamsList(eventStreams []*management.EventStream) error

func (*Renderer) Heading

func (r *Renderer) Heading(text ...string)

func (*Renderer) Infof

func (r *Renderer) Infof(format string, a ...interface{})

func (*Renderer) JSONCompactResult added in v1.17.0

func (r *Renderer) JSONCompactResult(data interface{})

func (*Renderer) JSONResult

func (r *Renderer) JSONResult(data interface{})

func (*Renderer) LogList

func (r *Renderer) LogList(logs []*management.Log, silent, hasFilter bool)

func (*Renderer) LogPrompt added in v1.13.0

func (r *Renderer) LogPrompt(logs []*management.Log, currentIndex *int) string

func (*Renderer) LogStreamCreate added in v0.8.0

func (r *Renderer) LogStreamCreate(logs *management.LogStream) error

func (*Renderer) LogStreamList added in v0.8.0

func (r *Renderer) LogStreamList(logs []*management.LogStream) error

func (*Renderer) LogStreamShow added in v0.8.0

func (r *Renderer) LogStreamShow(logs *management.LogStream) error

func (*Renderer) LogStreamUpdate added in v0.8.0

func (r *Renderer) LogStreamUpdate(logs *management.LogStream) error

func (*Renderer) LogTail added in v1.0.0

func (r *Renderer) LogTail(logs []*management.Log, ch <-chan []*management.Log, silent bool)

func (*Renderer) Markdown added in v0.3.2

func (r *Renderer) Markdown(document string)

func (*Renderer) MembersList added in v0.11.4

func (r *Renderer) MembersList(members []management.OrganizationMember)

func (*Renderer) NetworkACLCreate added in v1.12.0

func (r *Renderer) NetworkACLCreate(acl *management.NetworkACL) error

NetworkACLCreate displays the result of creating a network ACL.

func (*Renderer) NetworkACLList added in v1.12.0

func (r *Renderer) NetworkACLList(acls []*management.NetworkACL) error

NetworkACLList displays a list of network ACLs.

func (*Renderer) NetworkACLShow added in v1.12.0

func (r *Renderer) NetworkACLShow(acl *management.NetworkACL) error

NetworkACLShow displays a single network ACL.

func (*Renderer) NetworkACLUpdate added in v1.12.0

func (r *Renderer) NetworkACLUpdate(acl *management.NetworkACL) error

NetworkACLUpdate displays the result of updating a network ACL.

func (*Renderer) Newline

func (r *Renderer) Newline()

func (*Renderer) OrganizationCreate added in v0.10.0

func (r *Renderer) OrganizationCreate(organization *management.Organization)

func (*Renderer) OrganizationList added in v0.10.0

func (r *Renderer) OrganizationList(organizations []*management.Organization)

func (*Renderer) OrganizationShow added in v0.10.0

func (r *Renderer) OrganizationShow(organization *management.Organization)

func (*Renderer) OrganizationUpdate added in v0.10.0

func (r *Renderer) OrganizationUpdate(organization *management.Organization)

func (*Renderer) Output added in v0.10.3

func (r *Renderer) Output(message string)

func (*Renderer) PhoneProviderCreate added in v1.10.0

func (r *Renderer) PhoneProviderCreate(phoneProvider *management.BrandingPhoneProvider) error

func (*Renderer) PhoneProviderList added in v1.10.0

func (r *Renderer) PhoneProviderList(phoneProviders []*management.BrandingPhoneProvider) error

func (*Renderer) PhoneProviderShow added in v1.10.0

func (r *Renderer) PhoneProviderShow(phoneProvider *management.BrandingPhoneProvider) error

func (*Renderer) PhoneProviderUpdate added in v1.10.0

func (r *Renderer) PhoneProviderUpdate(phoneProvider *management.BrandingPhoneProvider) error

func (*Renderer) QuickstartList added in v0.5.0

func (r *Renderer) QuickstartList(quickstarts []auth0.Quickstart)

func (*Renderer) QuitPrompt added in v1.13.0

func (r *Renderer) QuitPrompt() bool

func (*Renderer) RenderDeliveryAttempts added in v1.19.0

func (r *Renderer) RenderDeliveryAttempts(attempts []*management.DeliveryAttempt)

func (*Renderer) RenderDeliveryMetadata added in v1.19.0

func (r *Renderer) RenderDeliveryMetadata(delivery *management.EventDelivery)

func (*Renderer) RenderEventStreamStats added in v1.19.0

func (r *Renderer) RenderEventStreamStats(stats *management.EventStreamStats)

func (*Renderer) Result

func (r *Renderer) Result(data View)

func (*Renderer) Results

func (r *Renderer) Results(data []View)

func (*Renderer) RoleCreate added in v0.7.0

func (r *Renderer) RoleCreate(role *management.Role)

func (*Renderer) RoleList added in v0.7.0

func (r *Renderer) RoleList(roles []*management.Role)

func (*Renderer) RolePermissionAdd added in v0.10.1

func (r *Renderer) RolePermissionAdd(role *management.Role, rs *management.ResourceServer, perms []string)

func (*Renderer) RolePermissionList added in v0.10.1

func (r *Renderer) RolePermissionList(perms []*management.Permission)

func (*Renderer) RolePermissionRemove added in v0.10.1

func (r *Renderer) RolePermissionRemove(role *management.Role, rs *management.ResourceServer, perms []string)

func (*Renderer) RoleShow added in v0.7.0

func (r *Renderer) RoleShow(role *management.Role)

func (*Renderer) RoleUpdate added in v0.7.0

func (r *Renderer) RoleUpdate(role *management.Role)

func (*Renderer) RuleCreate added in v0.3.0

func (r *Renderer) RuleCreate(rule *management.Rule)

func (*Renderer) RuleDisable added in v0.5.1

func (r *Renderer) RuleDisable(rule *management.Rule)

func (*Renderer) RuleEnable added in v0.5.1

func (r *Renderer) RuleEnable(rule *management.Rule)

func (*Renderer) RuleShow added in v0.3.0

func (r *Renderer) RuleShow(rule *management.Rule)

func (*Renderer) RuleUpdate added in v0.3.0

func (r *Renderer) RuleUpdate(rule *management.Rule)

func (*Renderer) RulesList added in v0.3.0

func (r *Renderer) RulesList(rules []*management.Rule)

func (*Renderer) ScopesList

func (r *Renderer) ScopesList(api string, scopes []management.ResourceServerScope)

func (*Renderer) SessionTransferShow added in v1.13.0

func (r *Renderer) SessionTransferShow(client *management.Client)

func (*Renderer) SessionTransferUpdate added in v1.13.0

func (r *Renderer) SessionTransferUpdate(client *management.Client, id string)

func (*Renderer) ShowDelivery added in v1.19.0

func (r *Renderer) ShowDelivery(delivery *management.EventDelivery)

func (*Renderer) Stream

func (r *Renderer) Stream(data []View, ch <-chan View)

func (*Renderer) SuspiciousIPThrottlingShow added in v0.11.7

func (r *Renderer) SuspiciousIPThrottlingShow(sit *management.SuspiciousIPThrottling)

func (*Renderer) SuspiciousIPThrottlingUpdate added in v0.11.7

func (r *Renderer) SuspiciousIPThrottlingUpdate(sit *management.SuspiciousIPThrottling)

func (*Renderer) TenantList added in v0.5.0

func (r *Renderer) TenantList(data []string)

func (*Renderer) TenantSettingsShow added in v1.14.0

func (r *Renderer) TenantSettingsShow(tenant *management.Tenant)

func (*Renderer) TenantSettingsUpdate added in v1.14.0

func (r *Renderer) TenantSettingsUpdate(tenant *management.Tenant)

func (*Renderer) TestLogin added in v1.0.0

func (r *Renderer) TestLogin(u *authutil.UserInfo, t *authutil.TokenResponse, clientID string)

func (*Renderer) TestToken added in v1.0.0

func (r *Renderer) TestToken(client *management.Client, t *authutil.TokenResponse)

func (*Renderer) TokenExchangeProfileCreate added in v1.25.0

func (r *Renderer) TokenExchangeProfileCreate(profile *management.TokenExchangeProfile)

func (*Renderer) TokenExchangeProfileList added in v1.25.0

func (r *Renderer) TokenExchangeProfileList(profiles []*management.TokenExchangeProfile)

func (*Renderer) TokenExchangeProfileShow added in v1.25.0

func (r *Renderer) TokenExchangeProfileShow(profile *management.TokenExchangeProfile)

func (*Renderer) TokenExchangeProfileUpdate added in v1.25.0

func (r *Renderer) TokenExchangeProfileUpdate(profile *management.TokenExchangeProfile)

func (*Renderer) UserBlocksList added in v0.5.1

func (r *Renderer) UserBlocksList(userBlocks []*management.UserBlock)

func (*Renderer) UserCreate added in v0.7.0

func (r *Renderer) UserCreate(user *management.User, requireUsername bool)

func (*Renderer) UserPrompt added in v1.14.0

func (r *Renderer) UserPrompt(users []*management.User, currentIndex *int) string

func (*Renderer) UserRoleList added in v1.0.0

func (r *Renderer) UserRoleList(roles []*management.Role)

func (*Renderer) UserSearch added in v0.7.0

func (r *Renderer) UserSearch(users []*management.User)

func (*Renderer) UserShow added in v0.7.0

func (r *Renderer) UserShow(user *management.User, requireUsername bool)

func (*Renderer) UserUpdate added in v0.7.0

func (r *Renderer) UserUpdate(user *management.User, requireUsername bool)

func (*Renderer) Warnf

func (r *Renderer) Warnf(format string, a ...interface{})

type SessionTransferView added in v1.13.0

type SessionTransferView struct {
	ID             string
	CanCreateTOKEN string
	AllowedMethods string
	DeviceBinding  string
	// contains filtered or unexported fields
}

func MakeSessionTransferView added in v1.13.0

func MakeSessionTransferView(client *management.Client) *SessionTransferView

func (*SessionTransferView) AsTableHeader added in v1.13.0

func (v *SessionTransferView) AsTableHeader() []string

func (*SessionTransferView) AsTableRow added in v1.13.0

func (v *SessionTransferView) AsTableRow() []string

func (*SessionTransferView) KeyValues added in v1.13.0

func (v *SessionTransferView) KeyValues() [][]string

func (*SessionTransferView) Object added in v1.13.0

func (v *SessionTransferView) Object() interface{}

type TenantSettingsView added in v1.14.0

type TenantSettingsView struct {
	SettingName      string
	FriendlyFlagName string
	Enabled          *bool
	// contains filtered or unexported fields
}

func (*TenantSettingsView) AsTableHeader added in v1.14.0

func (v *TenantSettingsView) AsTableHeader() []string

func (*TenantSettingsView) AsTableRow added in v1.14.0

func (v *TenantSettingsView) AsTableRow() []string

func (*TenantSettingsView) KeyValues added in v1.14.0

func (v *TenantSettingsView) KeyValues() [][]string

func (*TenantSettingsView) Object added in v1.14.0

func (v *TenantSettingsView) Object() interface{}

type View

type View interface {
	AsTableHeader() []string
	AsTableRow() []string
	Object() interface{}
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL