Skip to content

configure

Save connection settings to the config file (flag-driven, no prompts)

FlagTypeRequiredDescription
--auth-typestringNoauth type: basic, bearer, oauth2, oauth2-3lo
--base-urlstringNoConfluence base URL (required unless --delete)
--client-idstringNoOAuth2 client ID
--client-secretstringNoOAuth2 client secret
--cloud-idstringNoAtlassian Cloud site ID for OAuth2
--deleteboolNodelete the named profile
--profilestringNoprofile name to save settings under
--scopesstringNoOAuth2 scopes (space-separated)
--testboolNotest connection via GET /wiki/api/v2/spaces?limit=1 before saving
--tokenstringNoAPI token or bearer token (required unless --delete)
--usernamestringNousername for basic auth

Example:

bash
cf configure