Partners
A Partner is a first-class entity that cleanly represents an external organization, enables delegated administration, and enforces strict boundaries.
Resource Schema
Required
| Property | Description |
|---|---|
| name String | The name of the Partner. |
| root_folder String | The root folder path for this Partner. |
Optional
| Property | Description |
|---|---|
| allow_bypassing_2fa_policies Bool | Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users. |
| allowed_ips String | A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists. |
| allow_credential_changes Bool | Allow Partner Admins to change or reset credentials for users belonging to this Partner. |
| allow_providing_gpg_keys Bool | Allow Partner Admins to provide GPG keys. |
| allow_user_creation Bool | Allow Partner Admins to create users. |
| cc_emails_to_responsible_party Bool | When true, emails sent to Partner users are copied to the responsible User or Group. |
| ai_assistant_personality_id Int64 | AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it. |
| workspace_id Int64 | ID of the Workspace associated with this Partner. |
| notes String | Notes about this Partner. |
| partner_channel_template_id Int64 | ID of the Partner Channel Template assigned to this Partner. |
| responsible_group_id Int64 | ID of the Group responsible for this Partner. |
| responsible_user_id Int64 | ID of the User responsible for this Partner. |
| show_partner_channel_home_page Bool | Show Partner users a simplified home page built from this Partner's Channels. |
| tags String | Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens. |
Read Only
| Property | Description |
|---|---|
| id Int64 | The unique ID of the Partner. |
| partner_admin_ids List | Array of User IDs that are Partner Admins for this Partner. |
| partnership_role String | This site's role in Partner Site relationships for this Partner. Can be host, guest, host_and_guest, or null.Possible values: host, guest, host_and_guest |
| user_ids List | Array of User IDs that belong to this Partner. |
Resource Import
This Resource supports importing using the following syntax:
Data Source Schema
Required
| Property | Description |
|---|---|
| id Int64 | The unique ID of the Partner. |
Read Only
| Property | Description |
|---|---|
| allow_bypassing_2fa_policies Bool | Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users. |
| allowed_ips String | A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists. |
| allow_credential_changes Bool | Allow Partner Admins to change or reset credentials for users belonging to this Partner. |
| allow_providing_gpg_keys Bool | Allow Partner Admins to provide GPG keys. |
| allow_user_creation Bool | Allow Partner Admins to create users. |
| cc_emails_to_responsible_party Bool | When true, emails sent to Partner users are copied to the responsible User or Group. |
| ai_assistant_personality_id Int64 | AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it. |
| workspace_id Int64 | ID of the Workspace associated with this Partner. |
| name String | The name of the Partner. |
| notes String | Notes about this Partner. |
| partner_admin_ids List | Array of User IDs that are Partner Admins for this Partner. |
| partner_channel_template_id Int64 | ID of the Partner Channel Template assigned to this Partner. |
| partnership_role String | This site's role in Partner Site relationships for this Partner. Can be host, guest, host_and_guest, or null.Possible values: host, guest, host_and_guest |
| responsible_group_id Int64 | ID of the Group responsible for this Partner. |
| responsible_user_id Int64 | ID of the User responsible for this Partner. |
| root_folder String | The root folder path for this Partner. |
| show_partner_channel_home_page Bool | Show Partner users a simplified home page built from this Partner's Channels. |
| tags String | Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens. |
| user_ids List | Array of User IDs that belong to this Partner. |