Skip to main content
PATCH
Modify an organization template

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string<organization-template-id>
requis

Organization Template identifier.

Corps

name
string

The name of the organization template.

Required string length: 1 - 100
Pattern: ^[^\x00]*$
is_default
boolean

Whether this is the default template applied to new organizations.

organization_deletion_behavior
enum<string>

Controls whether organizations using this template can be deleted.

Options disponibles:
allow,
allow_if_empty
connection_deletion_behavior
enum<string>

Controls whether connections created from this template can be deleted.

Options disponibles:
allow,
allow_if_empty
enforce_permission_ceiling
boolean

Whether to enforce permission ceiling for organizations using this template.

enforce_self_assignment_restriction
boolean

Whether to enforce self-assignment restrictions for organizations using this template.

connection_profile_id
string<connection-profile-id> | null

The connection profile to apply to new connections.

user_attribute_profile_id
string<user-attribute-profile-id> | null

The user attribute profile to apply to organizations.

allowed_strategies
enum<string>[] | null

List of allowed connection strategies for this template.

An allowed enterprise connection strategy.

Options disponibles:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
invitation_landing_client_id
string<client-id> | null

The client ID for the invitation landing page.

admin_roles_assignment
string<role-id>[] | null

Default admin roles to assign to organization creators.

Maximum array length: 10

Role identifier.

use_for_organization_discovery
object | null

Controls whether connections from this template are used for organization discovery.

role_visibility_policy
object | null

Controls role visibility for organization administrators.

Réponse

Organization template successfully updated.

id
string<organization-template-id>

Organization Template identifier.

name
string

The name of the organization template.

Required string length: 1 - 100
Pattern: ^[^\x00]*$
is_default
boolean

Whether this is the default template applied to new organizations.

organization_deletion_behavior
enum<string>

Controls whether organizations using this template can be deleted.

Options disponibles:
allow,
allow_if_empty
connection_deletion_behavior
enum<string>

Controls whether connections created from this template can be deleted.

Options disponibles:
allow,
allow_if_empty
enforce_permission_ceiling
boolean

Whether to enforce permission ceiling for organizations using this template.

enforce_self_assignment_restriction
boolean

Whether to enforce self-assignment restrictions for organizations using this template.

connection_profile_id
string<connection-profile-id>

The connection profile to apply to new connections.

user_attribute_profile_id
string<user-attribute-profile-id>

The user attribute profile to apply to organizations.

allowed_strategies
enum<string>[]

List of allowed connection strategies for this template.

An allowed enterprise connection strategy.

Options disponibles:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
invitation_landing_client_id
string<client-id>

The client ID for the invitation landing page.

admin_roles_assignment
string<role-id>[]

Default admin roles to assign to organization creators.

Role identifier.

use_for_organization_discovery
object | null

Controls whether connections from this template are used for organization discovery.

role_visibility_policy
object | null

Controls role visibility for organization administrators.

created_at
string<date-time>

The ISO 8601 formatted timestamp representing when the template was created.

updated_at
string<date-time>

The ISO 8601 formatted timestamp representing when the template was last updated.