🪪 Tenant And Identity API
Account view configurations and admin alert channels. One-time password resets, provisioning flows, and active connection monitoring.
- Category: Platform
- Complexity: advanced
- Paths: 183 | Schemas: 511
- Tier: Standard
- Related domains:
users,authentication,system
Use Cases
Section titled “Use Cases”- Manage user profiles and notification preferences
- Configure session controls and OTP settings
- Handle identity management operations
- Process initial user access requests
Primary Resources
Section titled “Primary Resources”- user_profile: User profile with personal settings
- session: User session for authentication state
- otp_policy: OTP policy for multi-factor authentication
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| GET | /api/web/namespaces/system/allowed_tenants/support-tenant/access | GET Support Tenant Access. |
| POST | /api/web/namespaces/system/allowed_tenants/support-tenant/access | Update Support Tenant Access. |
| POST | /api/web/namespaces/{metadata.namespace}/allowed_tenants | Create Allowed Tenant. |
| PUT | /api/web/namespaces/{metadata.namespace}/allowed_tenants/{metadata.name} | Replace Allowed Tenant. |
| GET | /api/web/namespaces/{namespace}/allowed_tenants | List Allowed Tenant. |
| GET | /api/web/namespaces/{namespace}/allowed_tenants/{name} | GET Allowed Tenant. |
| DELETE | /api/web/namespaces/{namespace}/allowed_tenants/{name} | DELETE Allowed Tenant. |
| POST | /api/config/namespaces/{metadata.namespace}/authentications | Create Authentication. |
| PUT | /api/config/namespaces/{metadata.namespace}/authentications/{metadata.name} | Replace Authentication. |
| GET | /api/config/namespaces/{namespace}/authentications | List Authentication. |
| GET | /api/config/namespaces/{namespace}/authentications/{name} | GET Authentication. |
| DELETE | /api/config/namespaces/{namespace}/authentications/{name} | DELETE Authentication. |
| POST | /api/config/namespaces/{metadata.namespace}/authorization_servers | Create Authorization Server. |
| PUT | /api/config/namespaces/{metadata.namespace}/authorization_servers/{metadata.name} | Replace Authorization Server. |
| GET | /api/config/namespaces/{namespace}/authorization_servers | List Authorization Server. |
| GET | /api/config/namespaces/{namespace}/authorization_servers/{name} | GET Authorization Server. |
| DELETE | /api/config/namespaces/{namespace}/authorization_servers/{name} | DELETE Authorization Server. |
| POST | /api/waf/namespaces/{namespace}/authorization_servers/{name}/update | Update Authorization Server. |
| GET | /api/web/namespaces/system/partner-management/child_tenants | List of Child Tenants. |
| POST | /api/web/namespaces/system/partner-management/child_tenants/migrate | Migrate Child Tenants. |
| GET | /api/web/namespaces/system/partner-management/customer_supports | List all support tickets created in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports | Create customer support ticket in child tenant. |
| GET | /api/web/namespaces/system/partner-management/customer_supports/{tp_id} | GET customer support ticket in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/close | Close a customer support ticket in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment | Add comment to a customer support ticket in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/escalate | Escalate a ticket in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/priority | Change priority of a ticket in child tenant. |
| POST | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/reopen | Reopen a closed customer support ticket in child tenant. |
| POST | /api/web/namespaces/{metadata.namespace}/child_tenants | Child Tenant. |
| PUT | /api/web/namespaces/{metadata.namespace}/child_tenants/{metadata.name} | Replace Child Tenant. |
| GET | /api/web/namespaces/{namespace}/child_tenants | List Child Tenant. |
| GET | /api/web/namespaces/{namespace}/child_tenants/{name} | GET Child Tenant. |
| DELETE | /api/web/namespaces/{namespace}/child_tenants/{name} | DELETE Child Tenant. |
| GET | /api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants | List child tenants for a given child tenant manager. |
| POST | /api/web/namespaces/system/partner-management/child_tenant_managers/{name}/child_tenants/migrate | Migrate CTM child tenants. |
| POST | /api/web/namespaces/{metadata.namespace}/child_tenant_managers | Child Tenant Manager. |
| PUT | /api/web/namespaces/{metadata.namespace}/child_tenant_managers/{metadata.name} | Replace Child Tenant Manager. |
| GET | /api/web/namespaces/{namespace}/child_tenant_managers | List Child Tenant Manager. |
| GET | /api/web/namespaces/{namespace}/child_tenant_managers/{name} | GET Child Tenant Manager. |
| DELETE | /api/web/namespaces/{namespace}/child_tenant_managers/{name} | DELETE Child Tenant Manager. |
| GET | /api/web/namespaces/system/partner-management/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id} | GET attachment. |
| POST | /api/cloud-data/namespaces/system/cloud_user_accounts/discover_networks | Discover Cloud Networks. |
| POST | /api/web/namespaces/{metadata.namespace}/contacts | Create Contact. |
| PUT | /api/web/namespaces/{metadata.namespace}/contacts/{metadata.name} | Replace Contact. |
| GET | /api/web/namespaces/{namespace}/contacts | List Contact. |
| GET | /api/web/namespaces/{namespace}/contacts/{name} | GET Contact. |
| DELETE | /api/web/namespaces/{namespace}/contacts/{name} | DELETE Contact. |
| GET | /api/web/namespaces/system/managed_client/customer_supports | List tickets of managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports | Create customer support ticket in managed tenant. |
| GET | /api/web/namespaces/system/managed_client/customer_supports/{tp_id} | GET customer support ticket in managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/close | Close a customer support ticket in managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment | Add comment to a customer support ticket in managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/escalate | Escalate a ticket in managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/priority | Priority of a ticket in managed tenant. |
| POST | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/reopen | Reopen a closed customer support ticket in managed tenant. |
| GET | /api/web/namespaces/system/managed_tenants_by_user | GET List of Managed Tenant By User. |
| GET | /api/web/namespaces/system/managed_tenants_list | GET List of Managed Tenant. |
| GET | /api/web/namespaces/system/support-tenant/managed_tenants | List of Managed Tenant By User For Support Operations. |
| POST | /api/web/namespaces/{metadata.namespace}/managed_tenants | Create Managed Tenant. |
| PUT | /api/web/namespaces/{metadata.namespace}/managed_tenants/{metadata.name} | Replace Managed Tenant. |
| GET | /api/web/namespaces/{namespace}/managed_tenants | List Managed Tenant. |
| GET | /api/web/namespaces/{namespace}/managed_tenants/{name} | GET Managed Tenant. |
| DELETE | /api/web/namespaces/{namespace}/managed_tenants/{name} | DELETE Managed Tenant. |
| GET | /api/web/namespaces/system/managed_client/customer_supports/{tp_id}/comment/{comment_id}/attachment/{attachment_id} | GET attachment. |
| GET | /api/web/namespaces | List Namespace. |
| POST | /api/web/namespaces | Create Namespace. |
| POST | /api/config/namespaces/system/all_application_inventory | All Application Objects Inventory. |
| POST | /api/config/namespaces/system/all_application_inventory_waf_filters | All Application Objects Inventory with WAF Filters. |
| POST | /api/ml/data/namespaces/system/api_endpoints/all_ns_stats | GET API Endpoints Stats for All Namespaces. |
| POST | /api/web/namespaces/system/evaluate-api-access | Evaluate API Access. |
| POST | /api/web/namespaces/system/evaluate-batch-api-access | Evaluate Batch API Access. |
| POST | /api/web/namespaces/system/lookup-user-roles | Lookup User Roles. |
| POST | /api/config/namespaces/system/networking_inventory | Networking Objects Inventory. |
| POST | /api/cloud-data/namespaces/system/suggest-values | Suggest Values. |
| POST | /api/config/namespaces/system/update_allow_advertise_on_public | Update allow advertise on public. |
| POST | /api/config/namespaces/system/validate_rules | Validate Rules. |
| PUT | /api/web/namespaces/{metadata.name} | Replace Namespace. |
| GET | /api/config/namespaces/{namespace}/active_alert_policies | GET Active Alert Policies. |
| POST | /api/config/namespaces/{namespace}/active_alert_policies | Set Active Alert Policies. |
| GET | /api/config/namespaces/{namespace}/active_network_policies | GET Active Network Policies. |
| POST | /api/config/namespaces/{namespace}/active_network_policies | Set Active Network Policies. |
| GET | /api/config/namespaces/{namespace}/active_service_policies | GET Active Service Policies. |
| POST | /api/config/namespaces/{namespace}/active_service_policies | Set Active Service Policies. |
| POST | /api/ml/data/namespaces/{namespace}/api_endpoints/stats | GET API Endpoints Stats for Namespace. |
| POST | /api/config/namespaces/{namespace}/application_inventory | Application Objects Inventory. |
| GET | /api/config/namespaces/{namespace}/fast_acls_for_internet_vips | GET FastACLs For Internet VIPs. |
| POST | /api/config/namespaces/{namespace}/fast_acls_for_internet_vips | Set FastACLs For Internet VIPs. |
| POST | /api/web/namespaces/{namespace}/suggest-values | Suggest Values. |
| GET | /api/web/namespaces/{name} | GET Namespace. |
| POST | /api/web/namespaces/{name}/cascade_delete | Cascade DELETE. |
| GET | /api/web/namespaces/{namespace}/namespace_roles | List Namespace Role. |
| GET | /api/web/namespaces/{namespace}/namespace_roles/{name} | GET Namespace Role. |
| POST | /api/config/namespaces/{namespace}/dynamic-data | Dynamic Data. |
| GET | /api/web/namespaces/{namespace}/rbac_policys | List RBAC Policy. |
| GET | /api/web/namespaces/{namespace}/rbac_policys/{name} | GET RBAC Policy. |
| GET | /api/web/custom/namespaces/{namespace}/roles | Custom List Roles. |
| POST | /api/web/custom/namespaces/{namespace}/roles | Custom Create Role. |
| GET | /api/web/custom/namespaces/{namespace}/roles/{name} | Custom GET Role. |
| PUT | /api/web/custom/namespaces/{namespace}/roles/{name} | Custom Replace Role. |
| POST | /api/web/namespaces/{metadata.namespace}/roles | Create Role. |
| PUT | /api/web/namespaces/{metadata.namespace}/roles/{metadata.name} | Replace Role. |
| GET | /api/web/namespaces/{namespace}/roles | List Role |
| GET | /api/web/namespaces/{namespace}/roles/{name} | GET Role |
| DELETE | /api/web/namespaces/{namespace}/roles/{name} | DELETE Role. |
| GET | /api/web/custom/namespaces/{namespace}/oidc_provider/{name} | GET |
| POST | /api/web/custom/namespaces/{namespace}/oidc_provider/{name}/delete | DELETE |
| GET | /api/web/custom/namespaces/{namespace}/oidc_providers | List |
| POST | /api/web/custom/namespaces/{namespace}/oidc_providers | Create |
| GET | /api/web/custom/namespaces/{namespace}/oidc_providers/{name} | GET |
| POST | /api/web/custom/namespaces/{namespace}/oidc_providers/{name} | Replace |
| PUT | /api/web/custom/namespaces/{namespace}/oidc_providers/{name} | Replace |
| POST | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/delete | DELETE |
| GET | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers | GET OIDC mappers. |
| POST | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/mappers | Update OIDC mappers. |
| PUT | /api/web/custom/namespaces/{namespace}/oidc_providers/{name}/scim | Update OIDC provider SCIM Integration. |
| GET | /no_auth/countries/{country_code}/states/{prefix} | List states. |
| GET | /no_auth/countries/{country_code}/states/{state_code}/cities/{prefix} | List cities. |
| GET | /no_auth/countries/{prefix} | List countries. |
| POST | /no_auth/login/validate_registration | Validate Registration. |
| POST | /no_auth/send_password_email | Send Password Email. |
| GET | /no_auth/signup/{name} | Read Signup. |
| POST | /no_auth/validate_contact | Validate contact. |
| GET | /api/web/custom/countries/{country_code}/states/{prefix} | List states. |
| GET | /api/web/custom/countries/{country_code}/states/{state_code}/cities/{prefix} | List cities. |
| GET | /api/web/custom/countries/{prefix} | List countries. |
| GET | /api/scim/namespaces/system/v2/Groups | List group based on filters. |
| POST | /api/scim/namespaces/system/v2/Groups | Create group with users. |
| GET | /api/scim/namespaces/system/v2/Groups/{id} | List group based on ID. |
| DELETE | /api/scim/namespaces/system/v2/Groups/{id} | DELETE group based on ID. |
| PUT | /api/scim/namespaces/system/v2/Groups/{id} | Replace group based on ID. |
| PATCH | /api/scim/namespaces/system/v2/Groups/{id} | PATCH group based on ID. |
| GET | /api/scim/namespaces/system/v2/ResourceTypes | GET supported resources type. |
| GET | /api/scim/namespaces/system/v2/ResourceTypes/{id} | GET supported resources type. |
| GET | /api/scim/namespaces/system/v2/Schemas | Schemas |
| GET | /api/scim/namespaces/system/v2/Schemas/{id} | Schemas By ID. |
| GET | /api/scim/namespaces/system/v2/ServiceProviderConfig | List service provider configs. |
| GET | /api/scim/namespaces/system/v2/Users | GET all users. |
| POST | /api/scim/namespaces/system/v2/Users | Create User with Role Assignment. |
| GET | /api/scim/namespaces/system/v2/Users/{id} | GET User with ID. |
| DELETE | /api/scim/namespaces/system/v2/Users/{id} | DELETE user by ID. |
| PUT | /api/scim/namespaces/system/v2/Users/{id} | Update User and Role Assignments. |
| PATCH | /api/scim/namespaces/system/v2/Users/{id} | PATCH User. |
| GET | /no_auth/cname/lookup | Lookup cname. |
| GET | /no_auth/tenant/idm/settings/password_policy | GetPasswordPolicy. |
| POST | /api/web/namespaces/system/tenant/domain_owner/assign | Assign domain owner. |
| POST | /api/web/namespaces/system/tenant/domain_owner/unassign | Unassign domain owner. |
| GET | /api/web/namespaces/system/tenant/idm/events/last_login | GetLastLoginMap. |
| GET | /api/web/namespaces/system/tenant/idm/events/login | GetLoginEvents. |
| POST | /api/web/namespaces/system/tenant/idm/events/login_in_time | GetLoginEventsInTimeFrame. |
| GET | /api/web/namespaces/system/tenant/idm/settings | GetIDMSettings. |
| PUT | /api/web/namespaces/system/tenant/idm/settings | UpdateIDMSettings. |
| GET | /api/web/namespaces/system/tenant/idm/users/inactive | ListInactiveUsers. |
| GET | /api/web/namespaces/system/tenant/lookup | Lookup cname. |
| POST | /api/web/namespaces/system/tenant/request-delete | DELETE Tenant. |
| GET | /api/web/namespaces/system/tenant/settings | Tenant Settings. |
| PUT | /api/web/namespaces/system/tenant/settings | Tenant Settings. |
| PUT | /api/web/namespaces/system/tenant/settings/otp/disable | Disable tenant level OTP. |
| PUT | /api/web/namespaces/system/tenant/settings/otp/enable | Enable tenant level OTP. |
| GET | /api/web/namespaces/system/tenant/settings/tenant/favicon | Tenant favicon. |
| GET | /api/web/namespaces/system/tenant/settings/tenant/image | Tenant profile image. |
| DELETE | /api/web/namespaces/system/tenant/settings/tenant/image | DELETE tenant profile image. |
| PUT | /api/web/namespaces/system/tenant/settings/tenant/image | Update tenant profile image. |
| GET | /api/web/namespaces/system/tenant/settings/tenant/logo | Tenant logo. |
| GET | /api/web/namespaces/system/tenant/support-info | Support Info. |
| GET | /api/web/namespaces/system/tenant/tenant-escalation-doc | Tenant escalation document. |
| PUT | /api/saas/namespaces/system/v2/tenant/deactivate | DeactivateTenant. |
| GET | /api/web/static/namespaces/system/tenant/settings/tenant/favicon | Tenant favicon. |
| GET | /api/web/static/namespaces/system/tenant/settings/tenant/image | Tenant profile image. |
| GET | /api/config/tenants/{tenant}/summary | Summary |
| POST | /api/config/namespaces/{metadata.namespace}/tenant_configurations | Create tenant configuration. |
| PUT | /api/config/namespaces/{metadata.namespace}/tenant_configurations/{metadata.name} | Replace tenant configuration. |
| GET | /api/config/namespaces/{namespace}/tenant_configurations | List Tenant Configuration. |
| GET | /api/config/namespaces/{namespace}/tenant_configurations/{name} | GET tenant configuration. |
| DELETE | /api/config/namespaces/{namespace}/tenant_configurations/{name} | DELETE Tenant Configuration. |
| POST | /api/web/namespaces/system/tenant_management/delegated_access/subscribe | Subscribe Delegated Access Addon Service. |
| POST | /api/web/namespaces/system/tenant_management/delegated_access/unsubscribe | Unsubscribe Delegated Access Addon Service. |
| POST | /api/web/namespaces/{metadata.namespace}/tenant_profiles | Create Tenant Profile. |
| PUT | /api/web/namespaces/{metadata.namespace}/tenant_profiles/{metadata.name} | Replace Tenant Profile. |
| GET | /api/web/namespaces/{namespace}/tenant_profiles | List Tenant Profile. |
| GET | /api/web/namespaces/{namespace}/tenant_profiles/{name} | GET Tenant Profile. |
| DELETE | /api/web/namespaces/{namespace}/tenant_profiles/{name} | DELETE Tenant Profile. |
| POST | /api/web/custom/idm/user/sync | Sync user |
| PUT | /api/web/custom/namespaces/system/users/group_add | Add user to groups. |
| PUT | /api/web/custom/namespaces/system/users/group_remove | Remove user from groups. |
| POST | /api/web/custom/namespaces/{namespace}/accept_tos | Accept TOS. |
| POST | /api/web/custom/namespaces/{namespace}/role_users | Assign role to User. |
| POST | /api/web/custom/namespaces/{namespace}/send_password_email | Send Password Email. |
| GET | /api/web/custom/namespaces/{namespace}/tos | GET TOS |
| GET | /api/web/custom/namespaces/{namespace}/user_roles | GET User and Role Assignments. |
| POST | /api/web/custom/namespaces/{namespace}/user_roles | Create User with Role Assignment. |
| PUT | /api/web/custom/namespaces/{namespace}/user_roles | Update User and Role Assignments. |
| POST | /api/web/custom/namespaces/{namespace}/user_roles/{name} | Update User and Role Assignments. |
| POST | /api/web/custom/namespaces/{namespace}/users/cascade_delete | DELETE User and Related Objects. |
| GET | /api/web/custom/namespaces/{namespace}/whoami | GET User Details. |
| POST | /api/web/custom/password/admin_reset | Reset password by admin. |
| POST | /api/web/custom/password/reset | Reset password. |
| GET | /api/web/custom/namespaces/system/user_groups | GET all User Groups for the tenant. |
| POST | /api/web/custom/namespaces/system/user_groups | Create User Group. |
| POST | /api/web/custom/namespaces/system/user_groups/analyze_for_deletion | Analyze For Deletion. |
| GET | /api/web/custom/namespaces/system/user_groups/{name} | Fetch all the details for a group provided the group ID. |
| DELETE | /api/web/custom/namespaces/system/user_groups/{name} | DELETE a group provided the group ID. |
| PUT | /api/web/custom/namespaces/system/user_groups/{name} | Replace the User Group fields / accesses / associations. |
| PUT | /api/web/custom/namespaces/system/user_groups/{name}/assign_namespace_roles | Assign role to User Group. |
| PUT | /api/web/custom/namespaces/system/user_groups/{name}/remove_namespace_roles | Remove role from User Group. |
| GET | /api/web/namespaces/{namespace}/user_groups | List User Group. |
| GET | /api/web/namespaces/{namespace}/user_groups/{name} | GET User Group. |
| POST | /api/config/namespaces/{metadata.namespace}/user_identifications | Create User Identification. |
| PUT | /api/config/namespaces/{metadata.namespace}/user_identifications/{metadata.name} | Replace User Identification. |
| GET | /api/config/namespaces/{namespace}/user_identifications | List User Identification. |
| GET | /api/config/namespaces/{namespace}/user_identifications/{name} | GET User Identification. |
| DELETE | /api/config/namespaces/{namespace}/user_identifications/{name} | DELETE User Identification. |
| GET | /api/web/namespaces/system/user/admin_notifications | GET admin ntfn preferences. |
| PUT | /api/web/namespaces/system/user/admin_notifications | Update admin ntfn preferences. |
| PUT | /api/web/namespaces/system/user/admin_notifications/unset | Unset admin ntfn preference. |
| GET | /api/web/namespaces/system/user/combined_notifications | GET combined ntfn preferences. |
| PUT | /api/web/namespaces/system/user/combined_notifications | Update combined ntfn preferences. |
| GET | /api/web/namespaces/system/user/notifications | GET ntfn preferences. |
| PUT | /api/web/namespaces/system/user/notifications | Update ntfn preferences. |
| PUT | /api/web/namespaces/system/user/notifications/unset | Unset ntfn preference. |
| PUT | /api/web/namespaces/system/user/otp/admin_reset | ResetOtpDeviceByAdmin. |
| GET | /api/web/namespaces/system/user/sessions | GetUserSessions. |
| GET | /api/web/namespaces/system/user/settings | GET |
| PUT | /api/web/namespaces/system/user/settings | Update |
| PUT | /api/web/namespaces/system/user/settings/idm/disable | DisableUserInIDM. |
| PUT | /api/web/namespaces/system/user/settings/idm/enable | EnableUserInIDM. |
| GET | /api/web/namespaces/system/user/settings/image | GetUserProfileImage. |
| DELETE | /api/web/namespaces/system/user/settings/image | DeleteUserImage. |
| PUT | /api/web/namespaces/system/user/settings/image | UpdateUserImage. |
| PUT | /api/web/namespaces/system/user/settings/request_initial_access | Request Initial Access. |
| GET | /api/web/namespaces/system/user/settings/view_preference | GET view preference. |
| PUT | /api/web/namespaces/system/user/settings/view_preference | Set view preference. |
| GET | /api/config/namespaces/system/was/user_token | GET Web App Scanning Service User Token. |