Documentation
¶
Index ¶
- Constants
- Variables
- func ApplyColorToFriendlyAppType(a string) string
- func FriendlyAppType(appType string) string
- func MaskSecret(value string) string
- func OrDash(value string) string
- type DocsSearchResult
- type ErrorBody
- type ErrorEnvelope
- type LogView
- type OutputFormat
- type Renderer
- func (r *Renderer) ACULConfigList(aculConfigs *management.PromptRenderingList)
- func (r *Renderer) APICreate(api *management.ResourceServer)
- func (r *Renderer) APIList(apis []*management.ResourceServer)
- func (r *Renderer) APIShow(api *management.ResourceServer, jsonFlag bool)
- func (r *Renderer) APIUpdate(api *management.ResourceServer)
- func (r *Renderer) ActionCreate(action *management.Action)
- func (r *Renderer) ActionDeploy(action *management.Action)
- func (r *Renderer) ActionList(actions []*management.Action)
- func (r *Renderer) ActionModuleActionsList(actions []*managementv3.ActionModuleAction)
- func (r *Renderer) ActionModuleCreate(module *managementv3.CreateActionModuleResponseContent)
- func (r *Renderer) ActionModuleList(modules []*managementv3.ActionModuleListItem)
- func (r *Renderer) ActionModuleShow(module *managementv3.GetActionModuleResponseContent)
- func (r *Renderer) ActionModuleUpdate(module *managementv3.UpdateActionModuleResponseContent)
- func (r *Renderer) ActionModuleVersionList(versions []*managementv3.ActionModuleVersion)
- func (r *Renderer) ActionModuleVersionShow(version *managementv3.GetActionModuleVersionResponseContent)
- func (r *Renderer) ActionShow(action *management.Action)
- func (r *Renderer) ActionUpdate(action *management.Action)
- func (r *Renderer) ApplicationCreate(client *management.Client, revealSecrets bool)
- func (r *Renderer) ApplicationList(clients []*management.Client, revealSecrets bool)
- func (r *Renderer) ApplicationShow(client *management.Client, revealSecrets bool)
- func (r *Renderer) ApplicationUpdate(client *management.Client, revealSecrets bool)
- func (r *Renderer) BotDetectionShow(bd *managementv3.GetBotDetectionSettingsResponseContent)
- func (r *Renderer) BotDetectionUpdate(bd *managementv3.UpdateBotDetectionSettingsResponseContent)
- func (r *Renderer) BrandingShow(data *management.Branding)
- func (r *Renderer) BrandingTextShow(brandingTextJSON, prompt, language string)
- func (r *Renderer) BrandingTextUpdate(brandingTextJSON string, prompt, language string)
- func (r *Renderer) BrandingUpdate(data *management.Branding)
- func (r *Renderer) BreachedPasswordDetectionShow(bpd *management.BreachedPasswordDetection)
- func (r *Renderer) BreachedPasswordDetectionUpdate(bpd *management.BreachedPasswordDetection)
- func (r *Renderer) BruteForceProtectionShow(bfp *management.BruteForceProtection)
- func (r *Renderer) BruteForceProtectionUpdate(bfp *management.BruteForceProtection)
- func (r *Renderer) ClientGrantCreate(grant *managementv3.CreateClientGrantResponseContent)
- func (r *Renderer) ClientGrantList(grants []*managementv3.ClientGrantResponseContent)
- func (r *Renderer) ClientGrantOrganizationList(organizations []*managementv3.Organization)
- func (r *Renderer) ClientGrantShow(grant *managementv3.GetClientGrantResponseContent)
- func (r *Renderer) ClientGrantUpdate(grant *managementv3.UpdateClientGrantResponseContent)
- func (r *Renderer) ConfirmPrompt(prompt string) bool
- func (r *Renderer) ConnectionCreateRaw(connection json.RawMessage) error
- func (r *Renderer) ConnectionEnabledClientList(clients []*managementv3.ConnectionEnabledClient) error
- func (r *Renderer) ConnectionList(connections []*managementv3.ConnectionForList) error
- func (r *Renderer) ConnectionShowRaw(connection json.RawMessage) error
- func (r *Renderer) ConnectionUpdateRaw(connection json.RawMessage) error
- func (r *Renderer) CustomDomainCreate(customDomain *management.CustomDomain)
- func (r *Renderer) CustomDomainDefaultShow(defaultDomain *management.CustomDomain)
- func (r *Renderer) CustomDomainDefaultUpdate(defaultDomain *management.CustomDomain)
- func (r *Renderer) CustomDomainList(customDomains []*management.CustomDomain)
- func (r *Renderer) CustomDomainShow(customDomain *management.CustomDomain)
- func (r *Renderer) CustomDomainUpdate(customDomain *management.CustomDomain)
- func (r *Renderer) Detailf(format string, a ...interface{})
- func (r *Renderer) DocsSearchResults(results []DocsSearchResult, query string)
- func (r *Renderer) EmailProviderCreate(emailProvider *management.EmailProvider) error
- func (r *Renderer) EmailProviderShow(emailProvider *management.EmailProvider) error
- func (r *Renderer) EmailProviderUpdate(emailProvider *management.EmailProvider) error
- func (r *Renderer) EmailTemplateShow(email *management.EmailTemplate)
- func (r *Renderer) EmailTemplateUpdate(email *management.EmailTemplate)
- func (r *Renderer) EmptyState(resource string, hint string)
- func (r *Renderer) ErrorJSON(envelope ErrorEnvelope)
- func (r *Renderer) Errorf(format string, a ...interface{})
- func (r *Renderer) EventDeliveriesList(deliveries []*management.EventDelivery) error
- func (r *Renderer) EventDeliveryPrompt(deliveries []*management.EventDelivery, currentIndex *int) *management.EventDelivery
- func (r *Renderer) EventStreamCreate(eventStream *management.EventStream) error
- func (r *Renderer) EventStreamShow(eventStream *management.EventStream) error
- func (r *Renderer) EventStreamUpdate(eventStream *management.EventStream) error
- func (r *Renderer) EventStreamsList(eventStreams []*management.EventStream) error
- func (r *Renderer) FlowCreateRaw(flow json.RawMessage) error
- func (r *Renderer) FlowExecutionShowRaw(execution json.RawMessage) error
- func (r *Renderer) FlowExecutionsList(executions []*managementv3.FlowExecutionSummary) error
- func (r *Renderer) FlowExport(body string)
- func (r *Renderer) FlowShowRaw(flow json.RawMessage) error
- func (r *Renderer) FlowUpdateRaw(flow json.RawMessage) error
- func (r *Renderer) FlowVaultConnectionShowRaw(heading string, connection json.RawMessage) error
- func (r *Renderer) FlowVaultConnectionsList(connections []*managementv3.FlowsVaultConnectionSummary) error
- func (r *Renderer) FlowsList(flows []*managementv3.FlowSummary) error
- func (r *Renderer) FormCreateRaw(form json.RawMessage) error
- func (r *Renderer) FormExport(body string)
- func (r *Renderer) FormShowRaw(form json.RawMessage) error
- func (r *Renderer) FormUpdateRaw(form json.RawMessage) error
- func (r *Renderer) FormsList(forms []*managementv3.FormSummary) error
- func (r *Renderer) GuardianDetail(heading string, rows [][]string, raw interface{})
- func (r *Renderer) GuardianEnrollmentShow(enrollment *managementv3.GetGuardianEnrollmentResponseContent)
- func (r *Renderer) GuardianEnrollmentTicketCreate(ticket *managementv3.CreateGuardianEnrollmentTicketResponseContent)
- func (r *Renderer) GuardianFactorList(factors []*managementv3.GuardianFactor)
- func (r *Renderer) GuardianFactorSet(factor *managementv3.SetGuardianFactorResponseContent, name string)
- func (r *Renderer) GuardianPolicyList(policies []managementv3.MfaPolicyEnum)
- func (r *Renderer) Heading(text ...string)
- func (r *Renderer) Infof(format string, a ...interface{})
- func (r *Renderer) InvitationsCreate(invitation management.OrganizationInvitation)
- func (r *Renderer) InvitationsList(invitations []management.OrganizationInvitation)
- func (r *Renderer) InvitationsShow(invitation management.OrganizationInvitation)
- func (r *Renderer) JSONCompactResult(data interface{})
- func (r *Renderer) JSONResult(data interface{})
- func (r *Renderer) LogList(logs []*management.Log, silent, hasFilter bool)
- func (r *Renderer) LogPrompt(logs []*management.Log, currentIndex *int) string
- func (r *Renderer) LogStreamCreate(logs *management.LogStream) error
- func (r *Renderer) LogStreamList(logs []*management.LogStream) error
- func (r *Renderer) LogStreamShow(logs *management.LogStream) error
- func (r *Renderer) LogStreamUpdate(logs *management.LogStream) error
- func (r *Renderer) LogTail(logs []*management.Log, ch <-chan []*management.Log, silent bool)
- func (r *Renderer) Markdown(document string)
- func (r *Renderer) MembersList(members []management.OrganizationMember)
- func (r *Renderer) NetworkACLCreate(acl *management.NetworkACL) error
- func (r *Renderer) NetworkACLList(acls []*management.NetworkACL) error
- func (r *Renderer) NetworkACLShow(acl *management.NetworkACL) error
- func (r *Renderer) NetworkACLUpdate(acl *management.NetworkACL) error
- func (r *Renderer) Newline()
- func (r *Renderer) OrganizationCreate(organization *management.Organization)
- func (r *Renderer) OrganizationList(organizations []*management.Organization)
- func (r *Renderer) OrganizationShow(organization *management.Organization)
- func (r *Renderer) OrganizationUpdate(organization *management.Organization)
- func (r *Renderer) Output(message string)
- func (r *Renderer) OutputPreformattedJSON(message string)
- func (r *Renderer) PhoneProviderCreate(phoneProvider *management.BrandingPhoneProvider) error
- func (r *Renderer) PhoneProviderList(phoneProviders []*management.BrandingPhoneProvider) error
- func (r *Renderer) PhoneProviderShow(phoneProvider *management.BrandingPhoneProvider) error
- func (r *Renderer) PhoneProviderUpdate(phoneProvider *management.BrandingPhoneProvider) error
- func (r *Renderer) QuickstartList(quickstarts []auth0.Quickstart)
- func (r *Renderer) QuitPrompt() bool
- func (r *Renderer) RefreshTokenList(tokens []*managementv3.RefreshTokenResponseContent)
- func (r *Renderer) RefreshTokenShow(token *managementv3.GetRefreshTokenResponseContent)
- func (r *Renderer) RefreshTokenUpdate(token *managementv3.UpdateRefreshTokenResponseContent)
- func (r *Renderer) RenderDeliveryAttempts(attempts []*management.DeliveryAttempt)
- func (r *Renderer) RenderDeliveryMetadata(delivery *management.EventDelivery)
- func (r *Renderer) RenderEventStreamStats(stats *management.EventStreamStats)
- func (r *Renderer) Result(data View)
- func (r *Renderer) Results(data []View)
- func (r *Renderer) RoleCreate(role *management.Role)
- func (r *Renderer) RoleList(roles []*management.Role)
- func (r *Renderer) RolePermissionAdd(role *management.Role, rs *management.ResourceServer, perms []string)
- func (r *Renderer) RolePermissionList(perms []*management.Permission)
- func (r *Renderer) RolePermissionRemove(role *management.Role, rs *management.ResourceServer, perms []string)
- func (r *Renderer) RoleShow(role *management.Role)
- func (r *Renderer) RoleUpdate(role *management.Role)
- func (r *Renderer) RuleCreate(rule *management.Rule)
- func (r *Renderer) RuleDisable(rule *management.Rule)
- func (r *Renderer) RuleEnable(rule *management.Rule)
- func (r *Renderer) RuleShow(rule *management.Rule)
- func (r *Renderer) RuleUpdate(rule *management.Rule)
- func (r *Renderer) RulesList(rules []*management.Rule)
- func (r *Renderer) ScopesList(api string, scopes []management.ResourceServerScope)
- func (r *Renderer) SessionList(sessions []*managementv3.SessionResponseContent)
- func (r *Renderer) SessionShow(session *managementv3.GetSessionResponseContent)
- func (r *Renderer) SessionTransferShow(client *management.Client)
- func (r *Renderer) SessionTransferUpdate(client *management.Client, id string)
- func (r *Renderer) SessionUpdate(session *managementv3.UpdateSessionResponseContent)
- func (r *Renderer) ShowDelivery(delivery *management.EventDelivery)
- func (r *Renderer) Stream(data []View, ch <-chan View)
- func (r *Renderer) Successf(format string, a ...interface{})
- func (r *Renderer) SuspiciousIPThrottlingShow(sit *management.SuspiciousIPThrottling)
- func (r *Renderer) SuspiciousIPThrottlingUpdate(sit *management.SuspiciousIPThrottling)
- func (r *Renderer) TenantList(data []string)
- func (r *Renderer) TenantSettingsShow(tenant *management.Tenant)
- func (r *Renderer) TenantSettingsUpdate(tenant *management.Tenant)
- func (r *Renderer) TestLogin(u *authutil.UserInfo, t *authutil.TokenResponse, clientID string)
- func (r *Renderer) TestToken(client *management.Client, t *authutil.TokenResponse)
- func (r *Renderer) TokenExchangeProfileCreate(profile *management.TokenExchangeProfile)
- func (r *Renderer) TokenExchangeProfileList(profiles []*management.TokenExchangeProfile)
- func (r *Renderer) TokenExchangeProfileShow(profile *management.TokenExchangeProfile)
- func (r *Renderer) TokenExchangeProfileUpdate(profile *management.TokenExchangeProfile)
- func (r *Renderer) UserBlocksList(userBlocks []*management.UserBlock)
- func (r *Renderer) UserCreate(user *management.User, requireUsername bool)
- func (r *Renderer) UserPrompt(users []*management.User, currentIndex *int) string
- func (r *Renderer) UserRoleList(roles []*management.Role)
- func (r *Renderer) UserSearch(users []*management.User)
- func (r *Renderer) UserShow(user *management.User, requireUsername bool)
- func (r *Renderer) UserUpdate(user *management.User, requireUsername bool)
- func (r *Renderer) Warnf(format string, a ...interface{})
- type SessionTransferView
- type TenantSettingsView
- type View
Constants ¶
const ( MetricSuccessfulDeliveries = "auth0.event_streams.successful_deliveries" MetricFailedDeliveries = "auth0.event_streams.failed_deliveries" )
Variables ¶
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",
"ClientIDMetadataDocumentSupported": "client_id_metadata_document_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 FriendlyAppType ¶ added in v1.0.0
func MaskSecret ¶ added in v1.36.0
MaskSecret masks a stored secret for display. It never reveals the value, only whether one is set. This keeps credentials out of terminal output and logs, per the CLI's secret-handling rules.
Types ¶
type DocsSearchResult ¶ added in v1.37.0
DocsSearchResult is the display-facing shape of a documentation search hit and implements View directly. The cli layer builds these (URL is already mode-appropriate: ".md" in agent mode).
func (*DocsSearchResult) AsTableHeader ¶ added in v1.37.0
func (v *DocsSearchResult) AsTableHeader() []string
func (*DocsSearchResult) AsTableRow ¶ added in v1.37.0
func (v *DocsSearchResult) AsTableRow() []string
func (*DocsSearchResult) KeyValues ¶ added in v1.37.0
func (v *DocsSearchResult) KeyValues() [][]string
func (*DocsSearchResult) Object ¶ added in v1.37.0
func (v *DocsSearchResult) Object() interface{}
Object is what --json / --json-compact emit: an enriched object (not the raw API shape) so the mode-appropriate URL and snippet are present for scripting/agents.
type ErrorBody ¶ added in v1.36.0
type ErrorBody struct {
Code string `json:"code"`
Reason string `json:"reason,omitempty"`
Message string `json:"message"`
Status int `json:"status,omitempty"`
Details json.RawMessage `json:"details,omitempty"`
}
ErrorBody carries the classified error. Code is the coarse, stable failure class; Reason is a finer sub-classification that lives alongside it and is omitted when no finer classification is available. Status is omitted when the failure did not come from the Auth0 Management API. Details is an optional, structured JSON bag of extra context an agent can act on (for example the field-level validation failures of a rejected `--data` payload, or the "did you mean" candidates for a mistyped command under the "suggestions" key); it is omitted when empty.
type ErrorEnvelope ¶ added in v1.36.0
type ErrorEnvelope struct {
Error ErrorBody `json:"error"`
}
ErrorEnvelope is the machine-readable error emitted on stderr in JSON/agent mode, so agents can parse failures instead of scraping a human sentence.
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 (*LogView) AsTableHeaderString ¶ added in v1.13.0
func (*LogView) AsTableRow ¶ added in v1.13.0
func (*LogView) AsTableRowString ¶ added in v1.13.0
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
// AgentMode, when true, keeps stderr machine-clean: human diagnostics (info,
// success, detail, warning and non-fatal errors) and decorative output are
// suppressed, so the only thing an agent sees on stderr is the JSON error
// envelope on failure. It also selects the compact one-object-per-line form
// for streamed results. Enabled in agent mode.
AgentMode bool
}
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) ActionModuleActionsList ¶ added in v1.33.0
func (r *Renderer) ActionModuleActionsList(actions []*managementv3.ActionModuleAction)
func (*Renderer) ActionModuleCreate ¶ added in v1.33.0
func (r *Renderer) ActionModuleCreate(module *managementv3.CreateActionModuleResponseContent)
func (*Renderer) ActionModuleList ¶ added in v1.33.0
func (r *Renderer) ActionModuleList(modules []*managementv3.ActionModuleListItem)
func (*Renderer) ActionModuleShow ¶ added in v1.33.0
func (r *Renderer) ActionModuleShow(module *managementv3.GetActionModuleResponseContent)
func (*Renderer) ActionModuleUpdate ¶ added in v1.33.0
func (r *Renderer) ActionModuleUpdate(module *managementv3.UpdateActionModuleResponseContent)
func (*Renderer) ActionModuleVersionList ¶ added in v1.33.0
func (r *Renderer) ActionModuleVersionList(versions []*managementv3.ActionModuleVersion)
func (*Renderer) ActionModuleVersionShow ¶ added in v1.33.0
func (r *Renderer) ActionModuleVersionShow(version *managementv3.GetActionModuleVersionResponseContent)
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) BotDetectionShow ¶ added in v1.28.0
func (r *Renderer) BotDetectionShow(bd *managementv3.GetBotDetectionSettingsResponseContent)
func (*Renderer) BotDetectionUpdate ¶ added in v1.28.0
func (r *Renderer) BotDetectionUpdate(bd *managementv3.UpdateBotDetectionSettingsResponseContent)
func (*Renderer) BrandingShow ¶ added in v0.8.0
func (r *Renderer) BrandingShow(data *management.Branding)
func (*Renderer) BrandingTextShow ¶ added in v0.11.3
func (*Renderer) BrandingTextUpdate ¶ added in v0.11.3
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) ClientGrantCreate ¶ added in v1.33.0
func (r *Renderer) ClientGrantCreate(grant *managementv3.CreateClientGrantResponseContent)
func (*Renderer) ClientGrantList ¶ added in v1.33.0
func (r *Renderer) ClientGrantList(grants []*managementv3.ClientGrantResponseContent)
func (*Renderer) ClientGrantOrganizationList ¶ added in v1.33.0
func (r *Renderer) ClientGrantOrganizationList(organizations []*managementv3.Organization)
func (*Renderer) ClientGrantShow ¶ added in v1.33.0
func (r *Renderer) ClientGrantShow(grant *managementv3.GetClientGrantResponseContent)
func (*Renderer) ClientGrantUpdate ¶ added in v1.33.0
func (r *Renderer) ClientGrantUpdate(grant *managementv3.UpdateClientGrantResponseContent)
func (*Renderer) ConfirmPrompt ¶ added in v1.19.0
func (*Renderer) ConnectionCreateRaw ¶ added in v1.36.0
func (r *Renderer) ConnectionCreateRaw(connection json.RawMessage) error
ConnectionCreateRaw renders a full-fidelity create response.
func (*Renderer) ConnectionEnabledClientList ¶ added in v1.36.0
func (r *Renderer) ConnectionEnabledClientList(clients []*managementv3.ConnectionEnabledClient) error
ConnectionEnabledClientList renders the clients that have a connection enabled.
func (*Renderer) ConnectionList ¶ added in v1.36.0
func (r *Renderer) ConnectionList(connections []*managementv3.ConnectionForList) error
ConnectionList renders the connections list read through the v3 SDK.
func (*Renderer) ConnectionShowRaw ¶ added in v1.36.0
func (r *Renderer) ConnectionShowRaw(connection json.RawMessage) error
ConnectionShowRaw renders a full-fidelity connection response read through the v1 HTTP client, avoiding the v3 SDK's lossy per-strategy option unions.
func (*Renderer) ConnectionUpdateRaw ¶ added in v1.36.0
func (r *Renderer) ConnectionUpdateRaw(connection json.RawMessage) error
ConnectionUpdateRaw renders a full-fidelity update response.
func (*Renderer) CustomDomainCreate ¶ added in v0.8.1
func (r *Renderer) CustomDomainCreate(customDomain *management.CustomDomain)
func (*Renderer) CustomDomainDefaultShow ¶ added in v1.29.0
func (r *Renderer) CustomDomainDefaultShow(defaultDomain *management.CustomDomain)
func (*Renderer) CustomDomainDefaultUpdate ¶ added in v1.29.0
func (r *Renderer) CustomDomainDefaultUpdate(defaultDomain *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) Detailf ¶ added in v1.31.0
Detailf writes an indented detail line with no prefix symbol, used for supplementary information displayed beneath a success or info message.
func (*Renderer) DocsSearchResults ¶ added in v1.37.0
func (r *Renderer) DocsSearchResults(results []DocsSearchResult, query string)
DocsSearchResults renders a list of documentation search results.
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 (*Renderer) ErrorJSON ¶ added in v1.36.0
func (r *Renderer) ErrorJSON(envelope ErrorEnvelope)
ErrorJSON writes the error envelope as a single compact JSON line to stderr, keeping stdout clean for any partial result and giving agents one parseable line.
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) FlowCreateRaw ¶ added in v1.34.0
func (r *Renderer) FlowCreateRaw(flow json.RawMessage) error
FlowCreateRaw renders a full-fidelity create response.
func (*Renderer) FlowExecutionShowRaw ¶ added in v1.34.0
func (r *Renderer) FlowExecutionShowRaw(execution json.RawMessage) error
FlowExecutionShowRaw renders a full-fidelity execution response read through the v1 HTTP client.
func (*Renderer) FlowExecutionsList ¶ added in v1.34.0
func (r *Renderer) FlowExecutionsList(executions []*managementv3.FlowExecutionSummary) error
FlowExecutionsList renders the list of flow executions.
func (*Renderer) FlowExport ¶ added in v1.34.0
FlowExport writes a flow body verbatim (uncolored) to the result writer so it stays pipe- and import-friendly.
func (*Renderer) FlowShowRaw ¶ added in v1.34.0
func (r *Renderer) FlowShowRaw(flow json.RawMessage) error
FlowShowRaw renders a full-fidelity flow response read through the v1 HTTP client, avoiding the v3 SDK's lossy flow-action unions.
func (*Renderer) FlowUpdateRaw ¶ added in v1.34.0
func (r *Renderer) FlowUpdateRaw(flow json.RawMessage) error
FlowUpdateRaw renders a full-fidelity update response.
func (*Renderer) FlowVaultConnectionShowRaw ¶ added in v1.34.0
func (r *Renderer) FlowVaultConnectionShowRaw(heading string, connection json.RawMessage) error
FlowVaultConnectionShowRaw renders a full-fidelity vault connection response. The Management API never returns the write-only `setup` secrets, so nothing is masked here; the CLI simply never echoes the create/update body.
func (*Renderer) FlowVaultConnectionsList ¶ added in v1.34.0
func (r *Renderer) FlowVaultConnectionsList(connections []*managementv3.FlowsVaultConnectionSummary) error
FlowVaultConnectionsList renders the list of vault connections.
func (*Renderer) FlowsList ¶ added in v1.34.0
func (r *Renderer) FlowsList(flows []*managementv3.FlowSummary) error
FlowsList renders the list of flows.
func (*Renderer) FormCreateRaw ¶ added in v1.35.0
func (r *Renderer) FormCreateRaw(form json.RawMessage) error
FormCreateRaw renders a full-fidelity create response.
func (*Renderer) FormExport ¶ added in v1.35.0
FormExport writes a form body verbatim (uncolored) to the result writer so it stays pipe- and import-friendly.
func (*Renderer) FormShowRaw ¶ added in v1.35.0
func (r *Renderer) FormShowRaw(form json.RawMessage) error
FormShowRaw renders a full-fidelity form response read through the v1 HTTP client, avoiding the v3 SDK's lossy form-node unions.
func (*Renderer) FormUpdateRaw ¶ added in v1.35.0
func (r *Renderer) FormUpdateRaw(form json.RawMessage) error
FormUpdateRaw renders a full-fidelity update response.
func (*Renderer) FormsList ¶ added in v1.35.0
func (r *Renderer) FormsList(forms []*managementv3.FormSummary) error
FormsList renders the list of forms.
func (*Renderer) GuardianDetail ¶ added in v1.36.0
GuardianDetail renders a titled key/value detail for a Guardian factor provider configuration response.
func (*Renderer) GuardianEnrollmentShow ¶ added in v1.36.0
func (r *Renderer) GuardianEnrollmentShow(enrollment *managementv3.GetGuardianEnrollmentResponseContent)
func (*Renderer) GuardianEnrollmentTicketCreate ¶ added in v1.36.0
func (r *Renderer) GuardianEnrollmentTicketCreate(ticket *managementv3.CreateGuardianEnrollmentTicketResponseContent)
func (*Renderer) GuardianFactorList ¶ added in v1.36.0
func (r *Renderer) GuardianFactorList(factors []*managementv3.GuardianFactor)
func (*Renderer) GuardianFactorSet ¶ added in v1.36.0
func (r *Renderer) GuardianFactorSet(factor *managementv3.SetGuardianFactorResponseContent, name string)
func (*Renderer) GuardianPolicyList ¶ added in v1.36.0
func (r *Renderer) GuardianPolicyList(policies []managementv3.MfaPolicyEnum)
func (*Renderer) InvitationsCreate ¶ added in v1.27.0
func (r *Renderer) InvitationsCreate(invitation management.OrganizationInvitation)
func (*Renderer) InvitationsList ¶ added in v1.27.0
func (r *Renderer) InvitationsList(invitations []management.OrganizationInvitation)
func (*Renderer) InvitationsShow ¶ added in v1.27.0
func (r *Renderer) InvitationsShow(invitation management.OrganizationInvitation)
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) 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) 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) OutputPreformattedJSON ¶ added in v1.36.0
OutputPreformattedJSON writes an already-formatted JSON result to stdout, always terminating with a trailing newline regardless of the output format. It is for commands like `auth0 api` whose output is JSON even in the default (human) format: plain Output only appends the newline in the JSON output formats, so a piped human-mode result would otherwise lose its final line.
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 (*Renderer) RefreshTokenList ¶ added in v1.33.0
func (r *Renderer) RefreshTokenList(tokens []*managementv3.RefreshTokenResponseContent)
func (*Renderer) RefreshTokenShow ¶ added in v1.33.0
func (r *Renderer) RefreshTokenShow(token *managementv3.GetRefreshTokenResponseContent)
func (*Renderer) RefreshTokenUpdate ¶ added in v1.33.0
func (r *Renderer) RefreshTokenUpdate(token *managementv3.UpdateRefreshTokenResponseContent)
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) 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) SessionList ¶ added in v1.33.0
func (r *Renderer) SessionList(sessions []*managementv3.SessionResponseContent)
func (*Renderer) SessionShow ¶ added in v1.33.0
func (r *Renderer) SessionShow(session *managementv3.GetSessionResponseContent)
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) SessionUpdate ¶ added in v1.33.0
func (r *Renderer) SessionUpdate(session *managementv3.UpdateSessionResponseContent)
func (*Renderer) ShowDelivery ¶ added in v1.19.0
func (r *Renderer) ShowDelivery(delivery *management.EventDelivery)
func (*Renderer) Successf ¶ added in v1.31.0
Successf writes a success line with a green check-mark prefix.
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 (*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) 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)
type SessionTransferView ¶ added in v1.13.0
type SessionTransferView struct {
ID string
CanCreateTOKEN string
AllowedMethods string
DeviceBinding string
DelegationAllowAccess string
DelegationDeviceBinding 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{}
Source Files
¶
- action_module.go
- actions.go
- acul.go
- apis.go
- apps.go
- apps_session_transfer.go
- attack_protection.go
- branding.go
- branding_texts.go
- client_grant.go
- client_grant_organizations.go
- connections.go
- custom_domain.go
- display.go
- docs.go
- email_provider.go
- email_templates.go
- event_streams.go
- flows.go
- forms.go
- guardian.go
- invitations.go
- log_streams.go
- logs.go
- members.go
- network_acl.go
- organizations.go
- phone_provider.go
- quickstarts.go
- refresh_token.go
- role_permissions.go
- roles.go
- rules.go
- session.go
- tenant-settings.go
- tenants.go
- test.go
- token_exchange.go
- user_blocks.go
- users.go