Patch Tenant Information (v2.9)
PATCH/v2.9/api/tenants/:tenant_id
Patch all the tenant information for a tenant ID.
Request
Path Parameters
ID of the tenant.
- application/json
Body
Tenant details
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
X Panw Region
address Address
The address of the site.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
Adem Enabled
App Acceleration Enabled
The tenant canonical name. Max size = 128.
The client tenant.
The CSP tenant ID. Max length = 32.
The description of the tenant. Max size = 1024.
List the disabled tenants.
The reason for disabling the tenant.
The ID.
List the inactive tenants.
The reason for the tenant being inactive.
ipv4_list IPv4Address[]
The list of IPv4 addresses.
The IPv4 address of the tenant.
If the tenant is ESP.
True or False for oneapp.
True or False for PA IoT security license.
True or False for support.
The name of the tenant. Max size = 512.
operator Operator
The details of the operator.
addresses Address[]
The list of operator addresses. Max number of addresses = 20.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
custom_roles CustomRole[]
The list/details of the custom roles.
custom_permissions CustomPermission[]
The details of the custom role permissions.
Allowed After Ms
Allowed Before Ms
List the disabled custom permissions.
The reason for disabling the custom permission.
Disallow Permission
The ID.
List the inactive custom permissions.
The reason for the custom permission being inactive.
The region.
ID of the tenant.
The custom permission value.
List the disabled custom roles.
disallow_permissions AuthPermission[]
The details of the disallowed permissions.
The value of the permissions. Max size = 500.
The ID.
List the inactive custom roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
permissions AuthPermission[]
The permissions for the custom role.
The value of the permissions. Max size = 500.
roles AuthRole[]
The names of the roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
Lists if the tenant IdP log in option is disabled.
List the disabled tenants.
The reason for disabling the tenant.
The operator email ID.
Email Iam: Email(error = OPERATOR_EMAIL_IAM_INVALID: Invalid email {validatedValue}. Please use a valid email address, regexp = .*) Size(max = 1000, error = OPERATOR_EMAIL_IAM_INVALID: Invalid email {validatedValue}. Please use a valid email address, min = 1)
Validate the email ID.
Enable the sessin IP lock.
The first name of the operator. Max size = 100.
If the tenant is ESP.
The name of the ESP tenant. Max size = 512.
The ESP tenant ID.
The ID.
List the inactive tenants.
The reason for the tenant being inactive.
ipv4_list IPv4Address[]
The list of IPv4 addresses.
The IPv4 address of the tenant.
Is Locked
Is System Owned
The last name of the MSP tenant.
linked_accounts LinkedAccount[]required
Details of any linked accounts. Maximum of 20 and at least 1 linked account(s) should be specified.
List the disabled linked accounts.
The reason for disabling the linked accounts.
The number of failed login attempts.
The ID.
List the inactive linked accounts.
The reason for the linked accounts being inactive.
The linked account provider key.
The linked account provider value.
The linked account provider value updated date.
The region.
Tenant Id
migration_state MigrationState
Migration State
The name.
phone_numbers PhoneNumber[]
The details of the phone numbers.
The country code.
The local extension.
The phone number.
types Type[]
The type of phone number.
Value
The region of the tenant.
roles AuthRole[]
The defined MSP roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
secondary_emails Email[]
List of secondary email addresses. Max size = 20.
The email address.
The operator settings.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The tenant PAN CSP account ID. Max size = 32.
The PAN tenant ID. Max size = 32.
password_policy PasswordPolicy
The details of the password policy.
The failed login attempts is enabled.
The failed log in time delay is enabled.
The maximum password length is enabled.
The minimum password length is enabled.
Password aging is enabled.
The password identity difference is enabled.
The password no reuse count is enabled.
Enable the sessin IP lock.
The two lower case letters is enabled.
The two numbers is enabled.
The two special characters is enabled.
The two upper case letters is enabled.
The number of failed login attempts.
The maximum password length.
The minimum password length.
The number of password aging days.
The number of password aging notifications.
The password no reuse count.
The password special characters.
The special characters regex.
phone_numbers PhoneNumber[]
The details of the phone numbers.
The country code.
The local extension.
The phone number.
types Type[]
The type of phone number.
Value
The prisma access tenant ID. Max size = 32.
provider_data ProviderData[]
The details of the provider data.
certificate CertificateCa
The details of the certificate.
The details of the certificate.
The certificate expiry date.
The certificate type.
List the certificates.
The reason for disabling the certificate.
The ID.
List the inactive certificates.
The reason for the certificate being inactive.
issued_by CertificateIssuer
Details of the certificate issuer.
The name of the certificate issuer. Max size = 100.
The country of the certificate issuer. Max size = 100.
The location of the certificate issuer. Max size = 100.
The organization of the certificate issuer. Max size = 100.
The organization unit of the certificate issuer. Max size = 100.
The state of the certificate issuer. Max size = 100.
issued_to CertificateIssuer
Details of the who the certificate was issued to.
The name of the certificate issuer. Max size = 100.
The country of the certificate issuer. Max size = 100.
The location of the certificate issuer. Max size = 100.
The organization of the certificate issuer. Max size = 100.
The organization unit of the certificate issuer. Max size = 100.
The state of the certificate issuer. Max size = 100.
parent_id CertificateCa
The parent ID.
The region of the tenant.
The serial number of the certificate.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The version of the certificate.
The password.
provider Provider
The details of the provider.
The provider canonical name. Max size = 128.
The description of the provider. Max size = 1024.
List the disabled providers.
The reason for disabling the provider.
The ID.
List the inactive providers.
The reason for the provider being inactive.
The external group mapping.
The name of the provider.
protocol Protocol
The protocol.
The region of the provider.
The template used.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
Salt
Security
The region of the tenant.
The sase date.
The telemetry region.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The tenant TSG ID.
tsg_instances TsgInstance[]
The details of the TSG instances.
The app ID of the TSG instance.
The region of the TSG instance.
Tenant Id
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
X Panw Region
address Address
The address of the site.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
Adem Enabled
App Acceleration Enabled
The tenant canonical name. Max size = 128.
The client tenant.
The CSP tenant ID. Max length = 32.
The description of the tenant. Max size = 1024.
List the disabled tenants.
The reason for disabling the tenant.
The ID.
List the inactive tenants.
The reason for the tenant being inactive.
ipv4_list IPv4Address[]
The list of IPv4 addresses.
The IPv4 address of the tenant.
If the tenant is ESP.
True or False for oneapp.
True or False for PA IoT security license.
True or False for support.
The name of the tenant. Max size = 512.
operator Operator
The details of the operator.
addresses Address[]
The list of operator addresses. Max number of addresses = 20.
The name of the city. Max size = 100.
The name of the country. Max size = 100.
The postal code. Max size = 100.
The name of the state. Max size = 100.
The name of the street. Max size = 100.
The name of the street. Max size = 100.
custom_roles CustomRole[]
The list/details of the custom roles.
custom_permissions CustomPermission[]
The details of the custom role permissions.
Allowed After Ms
Allowed Before Ms
List the disabled custom permissions.
The reason for disabling the custom permission.
Disallow Permission
The ID.
List the inactive custom permissions.
The reason for the custom permission being inactive.
The region.
ID of the tenant.
The custom permission value.
List the disabled custom roles.
disallow_permissions AuthPermission[]
The details of the disallowed permissions.
The value of the permissions. Max size = 500.
The ID.
List the inactive custom roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
permissions AuthPermission[]
The permissions for the custom role.
The value of the permissions. Max size = 500.
roles AuthRole[]
The names of the roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
Lists if the tenant IdP log in option is disabled.
List the disabled tenants.
The reason for disabling the tenant.
The operator email ID.
Email Iam: Email(error = OPERATOR_EMAIL_IAM_INVALID: Invalid email {validatedValue}. Please use a valid email address, regexp = .*) Size(max = 1000, error = OPERATOR_EMAIL_IAM_INVALID: Invalid email {validatedValue}. Please use a valid email address, min = 1)
Validate the email ID.
Enable the sessin IP lock.
The first name of the operator. Max size = 100.
If the tenant is ESP.
The name of the ESP tenant. Max size = 512.
The ESP tenant ID.
The ID.
List the inactive tenants.
The reason for the tenant being inactive.
ipv4_list IPv4Address[]
The list of IPv4 addresses.
The IPv4 address of the tenant.
Is Locked
Is System Owned
The last name of the MSP tenant.
linked_accounts LinkedAccount[]required
Details of any linked accounts. Maximum of 20 and at least 1 linked account(s) should be specified.
List the disabled linked accounts.
The reason for disabling the linked accounts.
The number of failed login attempts.
The ID.
List the inactive linked accounts.
The reason for the linked accounts being inactive.
The linked account provider key.
The linked account provider value.
The linked account provider value updated date.
The region.
Tenant Id
migration_state MigrationState
Migration State
The name.
phone_numbers PhoneNumber[]
The details of the phone numbers.
The country code.
The local extension.
The phone number.
types Type[]
The type of phone number.
Value
The region of the tenant.
roles AuthRole[]
The defined MSP roles.
The name of the custom role. (guest|system|element|support_iam_admin|support_admin|support_viewonly|support_mfg|support_super|support_root|devops|secops|tenant_iam_admin|tenant_network_admin|tenant_security_admin|tenant_viewonly|tenant_super|tenant_root|esp_iam_admin|esp_machine_admin|esp_admin|esp_user|esp_super|esp_root))
secondary_emails Email[]
List of secondary email addresses. Max size = 20.
The email address.
The operator settings.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The tenant PAN CSP account ID. Max size = 32.
The PAN tenant ID. Max size = 32.
password_policy PasswordPolicy
The details of the password policy.
The failed login attempts is enabled.
The failed log in time delay is enabled.
The maximum password length is enabled.
The minimum password length is enabled.
Password aging is enabled.
The password identity difference is enabled.
The password no reuse count is enabled.
Enable the sessin IP lock.
The two lower case letters is enabled.
The two numbers is enabled.
The two special characters is enabled.
The two upper case letters is enabled.
The number of failed login attempts.
The maximum password length.
The minimum password length.
The number of password aging days.
The number of password aging notifications.
The password no reuse count.
The password special characters.
The special characters regex.
phone_numbers PhoneNumber[]
The details of the phone numbers.
The country code.
The local extension.
The phone number.
types Type[]
The type of phone number.
Value
The prisma access tenant ID. Max size = 32.
provider_data ProviderData[]
The details of the provider data.
certificate CertificateCa
The details of the certificate.
The details of the certificate.
The certificate expiry date.
The certificate type.
List the certificates.
The reason for disabling the certificate.
The ID.
List the inactive certificates.
The reason for the certificate being inactive.
issued_by CertificateIssuer
Details of the certificate issuer.
The name of the certificate issuer. Max size = 100.
The country of the certificate issuer. Max size = 100.
The location of the certificate issuer. Max size = 100.
The organization of the certificate issuer. Max size = 100.
The organization unit of the certificate issuer. Max size = 100.
The state of the certificate issuer. Max size = 100.
issued_to CertificateIssuer
Details of the who the certificate was issued to.
The name of the certificate issuer. Max size = 100.
The country of the certificate issuer. Max size = 100.
The location of the certificate issuer. Max size = 100.
The organization of the certificate issuer. Max size = 100.
The organization unit of the certificate issuer. Max size = 100.
The state of the certificate issuer. Max size = 100.
parent_id CertificateCa
The parent ID.
The region of the tenant.
The serial number of the certificate.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The version of the certificate.
The password.
provider Provider
The details of the provider.
The provider canonical name. Max size = 128.
The description of the provider. Max size = 1024.
List the disabled providers.
The reason for disabling the provider.
The ID.
List the inactive providers.
The reason for the provider being inactive.
The external group mapping.
The name of the provider.
protocol Protocol
The protocol.
The region of the provider.
The template used.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
Salt
Security
The region of the tenant.
The sase date.
The telemetry region.
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
The tenant TSG ID.
tsg_instances TsgInstance[]
The details of the TSG instances.
The app ID of the TSG instance.
The region of the TSG instance.
Tenant Id
{
"": "string",
"address": {
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
},
"adem_enabled": true,
"app_acceleration_enabled": true,
"canonical_name": "string",
"clients": [
"string"
],
"csp_tenant_id": "string",
"disabled": "string",
"disabled_reason": "string",
"id": "string",
"inactive": "string",
"inactive_reason": "string",
"ipv4_list": [
{
"ipv4": "string"
}
],
"is_esp": true,
"is_oneapp_ready": true,
"is_pa_iot_security_license": true,
"is_support": true,
"name": "string",
"operator": {
"addresses": [
{
"city": "string",
"country": "string",
"post_code": "string",
"state": "string",
"street": "string",
"street2": "string"
}
],
"custom_roles": [
{
"custom_permissions": [
{
"allowed_after_ms": 0,
"allowed_before_ms": 0,
"disabled": true,
"disabled_reason": "string",
"disallow_permission": true,
"id": "string",
"inactive": true,
"inactive_reason": "string",
"region": "string",
"tenant_id": "string",
"value": "string"
}
],
"disabled": true,
"disallow_permissions": [
{
"value": "string"
}
],
"id": "string",
"inactive": true,
"name": "string",
"permissions": [
{
"value": "string"
}
],
"roles": [
{
"name": "string"
}
]
}
],
"disable_idp_login": true,
"disabled": true,
"disabled_reason": "string",
"email": "string",
"email_iam": "string",
"email_validated": true,
"enable_session_ip_lock": true,
"first_name": "string",
"from_esp": true,
"from_esp_name": "string",
"from_esp_tenant_id": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"ipv4_list": [
{
"ipv4": "string"
}
],
"is_locked": true,
"is_system_owned": true,
"last_login": "2024-07-29",
"last_name": "string",
"linked_accounts": [
{
"disabled": true,
"disabled_reason": "string",
"failed_login_attempts": 0,
"id": "string",
"inactive": true,
"inactive_reason": "string",
"provider_key": "string",
"provider_value": "string",
"provider_value_updated_on": 0,
"region": "string",
"tenant_id": "string"
}
],
"migration_state": {},
"name": "string",
"phone_numbers": [
{
"country_code": 0,
"local_extension": 0,
"number": 0,
"types": [
{
"value": "string"
}
]
}
],
"region": "string",
"roles": [
{
"name": "string"
}
],
"secondary_emails": [
{
"email": "string"
}
],
"settings": "string",
"tenant_id": "string"
},
"pan_account_id": "string",
"pan_tenant_id": "string",
"password_policy": {
"enable_failed_login_attempts": true,
"enable_failed_login_time_delay": true,
"enable_maximum_password_length": true,
"enable_minimum_password_length": true,
"enable_password_aging": true,
"enable_password_identity_difference": true,
"enable_password_no_reuse_count": true,
"enable_session_ip_lock": true,
"enable_two_lower_case_letters": true,
"enable_two_numbers": true,
"enable_two_special_characters": true,
"enable_two_upper_case_letters": true,
"failed_login_attempts": 0,
"maximum_password_length": 0,
"minimum_password_length": 0,
"password_aging_days": 0,
"password_aging_notification": 0,
"password_no_reuse_count": 0,
"special_characters": "string",
"special_characters_regex": "string"
},
"phone_numbers": [
{
"country_code": 0,
"local_extension": 0,
"number": 0,
"types": [
{
"value": "string"
}
]
}
],
"prisma_access_tenant_id": "string",
"provider_data": [
{
"certificate": {
"certificate": "string",
"certificate_expiry_utc": 0,
"certificate_type": "string",
"disabled": true,
"disabled_reason": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"issued_by": {
"common_name": "string",
"country": "string",
"location": "string",
"organization": "string",
"organization_unit": "string",
"state": "string"
},
"issued_to": {
"common_name": "string",
"country": "string",
"location": "string",
"organization": "string",
"organization_unit": "string",
"state": "string"
},
"parent_id": {},
"region": "string",
"serial_number": "string",
"tenant_id": "string",
"version": "string"
},
"password_hash": "string",
"provider": {
"canonical_name": "string",
"disabled": true,
"disabled_reason": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"map_external_group": {},
"name": "string",
"protocol": {},
"region": "string",
"template": "string",
"tenant_id": "string"
},
"salt": "string",
"security": "string"
}
],
"region": "string",
"sase_at": "2024-07-29",
"telemetry_region": "string",
"tenant_id": "string",
"tsg_id": "string",
"tsg_instances": [
{
"app_id": "string",
"region": "string",
"tenant_id": "string"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "OPERATOR_INVALID_ETAG"
},
{
"code": "TENANT_PASSWORD_AGING_PREVENT_LOCKOUT"
},
{
"code": "TENANT_INVALID_CLIENT_ID"
},
{
"code": "ESP_INVALID_CLIENT_DATA"
}
]
}
}