Getting Started
Core Features
How-To Guides
Configuration
Troubleshooting
Integrations
This section allows you to manage the core properties and settings of your organization. Here, you can update your organization's name, branding elements like the logo and primary color, and other essential details. You can also perform critical actions such as transferring ownership or, if necessary, deleting the entire organization.
Managing these settings ensures your organization's profile is accurate and reflects your current needs.
You can view all the current details of your organization, including its name, unique identifier (slug), logo, website, and other configured properties. This overview helps you verify the current state of your organization's profile.
You can modify various aspects of your organization's profile. This includes general information, branding, and specific feature-related settings.
Access your organization's settings page within the application. This is typically found in a "Settings" or "Admin" section.
Locate the fields you wish to change. The following properties can be updated:
| Description |
|---|
| Name | The display name of your organization. |
| Slug | A unique, user-friendly identifier for your organization, often used in URLs. |
| Logo | The URL to your organization's logo image. |
| Metadata | Additional data associated with your organization. |
| Website | Your organization's official website URL. |
| Onboarding Completed | Indicates whether the initial onboarding process for the organization has been marked as complete. |
| Has Access | Controls general access to the organization. |
| Fleet DM Label ID | An identifier related to Fleet Device Management. |
| Is Fleet Setup Completed | Indicates whether the Fleet Device Management setup is complete. |
| Primary Color | The main brand color for your organization, typically in hexadecimal format (e.g., #3B82F6). |
After making your desired edits, save the changes. The system will update your organization's profile with the new information.
Transferring ownership is a critical action that assigns the highest level of administrative control over your organization to another member. The new owner will have full permissions, including the ability to manage other members, update settings, and delete the organization.
Navigate to the organization settings and find the section dedicated to ownership transfer.
You will need to enter the unique identifier (ID) of the member you wish to designate as the new owner.
If you are performing this action using an API key, you might also need to explicitly provide your own user ID (the current owner's ID) in the request to confirm the transfer. When using the application's user interface, your ID is automatically recognized.
Review the details and confirm the ownership transfer. A confirmation prompt may appear to prevent accidental transfers.
Deleting an organization is a permanent and irreversible action. This will remove all associated data, members, and resources.
Deleting your organization cannot be undone. All data, configurations, and associated resources will be permanently removed. Proceed with extreme caution.
Go to your organization's settings page.
Find the section or button specifically for deleting the organization. This is often clearly labeled and may be separated from other settings.
You will typically be asked to confirm this action, often by typing the organization's name or ID, to ensure you understand the gravity of the operation.
Once confirmed, the organization and all its data will be permanently deleted.
You can retrieve the primary color configured for your organization. This color is often used for branding and theming within the application or for external integrations.
The primary color can be retrieved even without full authentication if a specific access token is provided. This allows for public-facing elements to adopt your organization's branding without requiring a user to log in.
The primary color is returned in a hexadecimal format (e.g., #3B82F6).