Get Tenant Operators (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/operators

Get a list of tenant operators.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items OperatorV2N1[]
Array [
addresses Address[]
The list of operator addresses. Max number of addresses = 20.
Array [
city string
The name of the city. Max size = 100.
country string
The name of the country. Max size = 100.
post_code string
The postal code. Max size = 100.
state string
The name of the state. Max size = 100.
street string
The name of the street. Max size = 100.
street2 string
The name of the street. Max size = 100.
]
custom_roles CustomRoleV2N1[]
The list/details of the custom roles.
Array [
custom_permissions CustomPermission[]
The details of the custom role permissions.
Array [
allowed_after_ms int64
Allowed After Ms
allowed_before_ms int64
Allowed Before Ms
disabled boolean
List the disabled custom permissions.
disabled_reason string
The reason for disabling the custom permission.
disallow_permission boolean
Disallow Permission
id string
The ID.
inactive boolean
List the inactive custom permissions.
inactive_reason string
The reason for the custom permission being inactive.
region string
The region.
tenant_id stringrequired
ID of the tenant.
value stringrequired
The custom permission value.
]
description
The descriptions of the custom roles.
disabled boolean
List the disabled custom roles.
disabled_reason string
The reason for disabling the custom role.
disallow_permissions AuthPermission[]
The details of the disallowed permissions.
Array [
value string
The value of the permissions. Max size = 500.
]
id string
The ID.
inactive boolean
List the inactive custom roles.
inactive_reason string
Reason the custom role is inactive.
is_system_owned boolean
The custom role is system owned.
name stringrequired
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.
Array [
value string
The value of the permissions. Max size = 500.
]
region string
The region.
roles AuthRole[]
The names of the roles.
Array [
name stringrequired
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))
]
tenant_id stringrequired
ID of the tenant.
]
disable_idp_login boolean
Lists if the tenant IdP log in option is disabled.
disabled boolean
List the disabled tenants.
disabled_reason string
The reason for disabling the tenant.
email stringrequired
The operator email ID.
email_validated boolean
Validate the email ID.
enable_session_ip_lock boolean
Enable the sessin IP lock.
first_name stringrequired
The first name of the operator. Max size = 100.
from_esp boolean
If the tenant is ESP.
from_esp_name string
The name of the ESP tenant. Max size = 512.
from_esp_tenant_id string
The ESP tenant ID.
id string
The ID.
inactive boolean
List the inactive tenants.
inactive_reason string
The reason for the tenant being inactive.
ipv4_list IPv4Address[]
The list of IPv4 addresses.
Array [
ipv4 string
The IPv4 address of the tenant.
]
is_locked boolean
Is Locked
is_system_owned boolean
The custom role is system owned.
last_login date
The last log in time.
last_name string
The last name of the ESP tenant.
linked_accounts LinkedAccount[]required
Details of any linked accounts. Maximum of 20 and at least 1 linked account(s) should be specified.
Array [
disabled boolean
List the disabled linked accounts.
disabled_reason string
The reason for disabling the linked accounts.
failed_login_attempts int32
The number of failed login attempts.
id string
The ID.
inactive boolean
List the inactive linked accounts.
inactive_reason string
The reason for the linked accounts being inactive.
provider_key string
The linked account provider key.
provider_value string
The linked account provider value.
provider_value_updated_on int64
The linked account provider value updated date.
region string
The region.
tenant_id string
Tenant Id
]
name string
The name.
phone_numbers PhoneNumber[]
The details of the phone numbers.
Array [
country_code int32
The country code.
local_extension int32
The local extension.
number int64
The phone number.
types Type[]
The type of phone number.
Array [
value string
Value
]
]
region string
The region of the tenant.
roles AuthRole[]
The defined ESP roles.
Array [
name stringrequired
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.
Array [
email string
The email address.
]
settings string
The operator settings.
tenant_id stringrequired
ID of the tenant.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "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,
          "disabled_reason": "string",
          "disallow_permissions": [
            {
              "value": "string"
            }
          ],
          "id": "string",
          "inactive": true,
          "inactive_reason": "string",
          "is_system_owned": true,
          "name": "string",
          "permissions": [
            {
              "value": "string"
            }
          ],
          "region": "string",
          "roles": [
            {
              "name": "string"
            }
          ],
          "tenant_id": "string"
        }
      ],
      "disable_idp_login": true,
      "disabled": true,
      "disabled_reason": "string",
      "email": "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"
        }
      ],
      "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"
    }
  ]
}

Loading...