Skip to main content

signaloid-cli users customization

View the customization settings for your account.

Synopsis​

signaloid-cli users customization [options]

Options​

OptionDescription
--format <type>Output format: table or json (default: json)

Description​

Returns the customization settings of your account, i.e., the organizations you belong to, whether atomic networks are enabled, and any branding logo configured for your organization.

The command always reports on the authenticated user. It resolves your own UserID first and then fetches your customization settings.

If your account does not belong to any organization, the API returns HTTP status 404 with the message "Customization not found", and the command exits with code 4.

Output​

{
"Object": "Customization",
"UserID": "usr_12345661ad6641899387b6458cc9a2e2",
"LogoURL": "https://assets.signaloid.io/org/acme/logo.svg",
"AtomicNetworks": false,
"Organizations": ["org_9f2c1b7e4a3d4f8e9b0c1d2e3f4a5b6c"]
}

Examples​

View customization:

signaloid-cli users customization

As a table:

signaloid-cli users customization --format table

List the organizations you belong to:

signaloid-cli users customization | jq -r '.Organizations[]'

Exit Codes​

CodeDescription
0Success
1Failed to fetch customization
3Not authenticated, or the session has expired
4User not found, or your account does not belong to any organization

See Also​