---
updatedAt: 2026-05-21T16:41:24.000Z
---

# Retrieves a list of tenant properties for the specified tenant. 

<strong>Entitlement required:</strong> manageTenantProperties (Manage tenant properties) or readTenantProperties (Read tenant properties)

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.0.0",
    "description": "General configuration",
    "title": "General configuration"
  },
  "servers": [
    {
      "url": "https://{tenanturl}",
      "variables": {
        "tenanturl": {
          "default": "{tenant_url}",
          "description": "URL of your IBM Security Verify tenant"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Tenant Properties API 2.0"
    }
  ],
  "paths": {
    "/v2.0/tenant/properties": {
      "get": {
        "tags": [
          "Tenant Properties API 2.0"
        ],
        "summary": "Retrieves a list of tenant properties for the specified tenant. ",
        "description": "<strong>Entitlement required:</strong> manageTenantProperties (Manage tenant properties) or readTenantProperties (Read tenant properties)",
        "operationId": "getTenantProperties_0",
        "responses": {
          "200": {
            "description": "The request succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantPropertiesModelV2"
                }
              }
            }
          },
          "400": {
            "description": "The request is invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalErrorMessage"
                }
              }
            }
          },
          "500": {
            "description": "An internal server error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalErrorMessage"
                }
              }
            }
          }
        },
        "x-publicAPI": "true",
        "x-category": "General configuration"
      }
    }
  },
  "components": {
    "schemas": {
      "ExternalErrorMessage": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "The error code."
          },
          "messageId": {
            "type": "string",
            "description": "The ID of the message."
          },
          "messageDescription": {
            "type": "string",
            "description": "The message description."
          }
        }
      },
      "AccessControlAllowOrigin": {
        "required": [
          "origin",
          "regex"
        ],
        "type": "object",
        "properties": {
          "origin": {
            "type": "string",
            "description": "Allowed domain or a regular expression for allowed domains.",
            "example": "https://www.ibm.com"
          },
          "regex": {
            "type": "boolean",
            "description": "Boolean that indicates if the specified origin is a regular expression."
          }
        }
      },
      "ChannelThresholdSettings": {
        "type": "object",
        "properties": {
          "enablePerRecipientThreshold": {
            "type": "boolean",
            "description": "Enable per recipient threshold for notifications.",
            "example": true
          },
          "perRecipient": {
            "$ref": "#/components/schemas/ThresholdConfig"
          }
        }
      },
      "NotificationEmail": {
        "required": [
          "senderAddress",
          "senderName"
        ],
        "type": "object",
        "properties": {
          "senderName": {
            "type": "string",
            "description": "The name of the sender.",
            "example": "Personal Email"
          },
          "senderAddress": {
            "type": "string",
            "description": "The email address of the sender.",
            "example": "personalemail@maildomain.com"
          },
          "provider": {
            "type": "string",
            "description": "The email provider. Valid values are default or smtp.",
            "example": "smtp"
          },
          "smtp": {
            "$ref": "#/components/schemas/SMTPServer"
          }
        }
      },
      "NotificationSMS": {
        "required": [
          "alphaSenderId"
        ],
        "type": "object",
        "properties": {
          "alphaSenderId": {
            "type": "string",
            "description": "The alpha numeric sender id. Can contain up to 11 characters",
            "example": "IBMSecurity"
          }
        }
      },
      "NotificationThresholdSettings": {
        "type": "object",
        "properties": {
          "sms": {
            "$ref": "#/components/schemas/ChannelThresholdSettings"
          },
          "email": {
            "$ref": "#/components/schemas/ChannelThresholdSettings"
          },
          "voice": {
            "$ref": "#/components/schemas/ChannelThresholdSettings"
          },
          "smtpFailureProtection": {
            "$ref": "#/components/schemas/SmtpFailureProtectionConfig"
          }
        }
      },
      "SMTPServer": {
        "required": [
          "host",
          "password",
          "port",
          "protocol",
          "username"
        ],
        "type": "object",
        "properties": {
          "host": {
            "type": "string",
            "description": "The hostname of the SMTP server.",
            "example": "smtphost.com"
          },
          "port": {
            "type": "string",
            "description": "The port of the SMTP server. The range is 1 - 65535.",
            "example": "1234"
          },
          "username": {
            "type": "string",
            "description": "The username of the SMTP server.",
            "example": "bob"
          },
          "password": {
            "type": "string",
            "description": "The password of the SMTP server",
            "example": "********"
          },
          "protocol": {
            "type": "string",
            "description": "The SMTP protocol. Valid values are SSL or TLS",
            "example": "SSL"
          }
        }
      },
      "SmtpFailureProtectionConfig": {
        "type": "object",
        "properties": {
          "failureThreshold": {
            "type": "integer",
            "description": "Number of SMTP failures before blocking.",
            "format": "int32",
            "example": 10
          },
          "blockDurationMinutes": {
            "type": "integer",
            "description": "Duration in minutes to block SMTP after threshold is reached.",
            "format": "int32",
            "example": 15
          }
        }
      },
      "TargetUrlAllowedHost": {
        "required": [
          "regex",
          "targetUrl"
        ],
        "type": "object",
        "properties": {
          "targetUrl": {
            "type": "string",
            "description": "Target URL or a regular expression for allowed hosts.",
            "example": "https://www.ibm.com"
          },
          "regex": {
            "type": "boolean",
            "description": "Boolean that indicates if the specified target URL is a regular expression."
          }
        }
      },
      "TenantPropertiesModelV2": {
        "type": "object",
        "properties": {
          "accessControlAllowOrigin": {
            "type": "array",
            "description": "A list of allowed domains or regular expressions for allowed domains.",
            "example": "[{\"regex\": false,\"origin\": \"https://www.ibm.com\"},{\"regex\": true,\"origin\": \"^https\"}]",
            "items": {
              "$ref": "#/components/schemas/AccessControlAllowOrigin"
            }
          },
          "targetUrlAllowedHostV2": {
            "type": "array",
            "description": "A list of target URLs or regular expressions for allowed hosts.",
            "example": "[{\"regex\": false,\"targetUrl\": \"https://tenantname.com\"},{\"regex\": true,\"targetUrl\": \"^https\"}]",
            "items": {
              "$ref": "#/components/schemas/TargetUrlAllowedHost"
            }
          },
          "securityHeaderContentSecurityPolicy": {
            "type": "string",
            "description": "A string for the Content Security Policy (CSP) header.",
            "example": "default-src 'self' example.com *.example.com"
          },
          "notificationEmail": {
            "$ref": "#/components/schemas/NotificationEmail"
          },
          "notificationSMS": {
            "$ref": "#/components/schemas/NotificationSMS"
          },
          "notificationThreshold": {
            "$ref": "#/components/schemas/NotificationThresholdSettings"
          }
        }
      },
      "ThresholdConfig": {
        "type": "object",
        "properties": {
          "maxRequestCount": {
            "type": "integer",
            "description": "Maximum number of notification requests allowed.",
            "format": "int32",
            "example": 10
          },
          "period": {
            "type": "integer",
            "description": "Time period in seconds for the threshold.",
            "format": "int32",
            "example": 600
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-explorer-enabled": false
}
```